Metadata-Version: 2.1
Name: scifin
Version: 0.0.8
Summary: SciFin is a python package for Science and Finance.
Home-page: https://github.com/SciFin-Team/SciFin
License: MIT
Keywords: SciFin,scifin,science,finance
Author: Fabien Nugier
Author-email: fabien.nugier@outlook.com
Requires-Python: >=3.6.1,<4.0.0
Classifier: Environment :: Console
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Financial and Insurance Industry
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Software Development :: Build Tools
Requires-Dist: IPython (>=7.13.0,<8.0.0)
Requires-Dist: matplotlib (>=3.1.3,<4.0.0)
Requires-Dist: numpy (>=1.18.1,<2.0.0)
Requires-Dist: pandas (>=1.0.3,<2.0.0)
Requires-Dist: pandas_datareader (>=0.8.1,<0.9.0)
Requires-Dist: requests (>=2.23.0,<3.0.0)
Requires-Dist: scikit-learn (>=0.23.0,<0.24.0)
Requires-Dist: scipy (>=1.4.1,<2.0.0)
Requires-Dist: statsmodels (>=0.11.0,<0.12.0)
Project-URL: Documentation, https://github.com/SciFin-Team/SciFin/wiki
Project-URL: Repository, https://github.com/SciFin-Team/SciFin
Description-Content-Type: text/markdown


<p align="center">
  <img src="https://github.com/SciFin-Team/SciFin/blob/master/docs/logos/logo_scifin_github.jpg" width=400 title="hover text">
</p>



# SciFin

SciFin is a python package for Science and Finance.

## Summary

The SciFin package is a Python package designed to gather and develop methods for scientific studies and financial services. It originates from the observation that numerous methods developed in scientific fields (such as mathematics, physics, biology and climate sciences) have direct applicability in finance and that, conversely, multiple methods developed in finance can benefit science.

The development goal of this package is to offer a toolbox that can be used to derive specific applications both in research and business. Its purpose is not only to bring these fields together, but also to increase interoperability between them, helping science turn into business and finance to get new insights from science. Some functions will thus be neutral to any scientific or economic fields, while others will be more specialized for precise tasks. The motivationg behind this design is to provide tools that perform advanced tasks without depending on too many parameters.


## Contents

The current development is focused on the following topics:
- `classifier`: Classification techniques
- `fouriertrf`: Fourier transforms
- `geneticalg`: Genetic algorithms
- `marketdata`: Reading market data
- `montecarlo`: Monte Carlo simulations
- `neuralnets`: Neural networks
- `statistics`: Basic statistics
- `timeseries`: Time series analysis

Other topics will later follow.


## Installation

Installing SciFin on Linux or Mac is very easy, you can simply run `pip install SciFin` on the Terminal command line. You can also access the last version of the package on PyPI by clicking [--> Here <--](https://pypi.org/project/scifin/).

If you encounter problems during installation or after and think you know how the problem can be improved, please share it with me.


## Contact

If you have comments or suggestions, you can reach Fabien Nugier. Thank you very much in advance for your feedback.

The package written tries to follow the style guide for Python code [PEP8](https://www.python.org/dev/peps/pep-0008/). If you find any part of the code unclear, please let me know. As for docstrings, the format we try to follow here is given by the [numpy doc style](https://numpydoc.readthedocs.io/en/latest/format.html).

If you wish to contribute, please contact me through GitHub. I strongly advise to have a fair knowledge of Python and recommand the following [Python3 Tutorial](https://www.python-course.eu/python3_course.php) which is a mine of information.






