Metadata-Version: 2.1
Name: montecarlosim
Version: 0.1.0
Summary: MonteCarlo simulation library
License: MIT
Author: Valerio Farrotti
Author-email: valerio.farrotti@gmail.com
Maintainer: Valerio Farrotti
Maintainer-email: valerio.farrotti@gmail.com
Requires-Python: >=3.10.0,<4.0.0
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering
Requires-Dist: matplotlib (>=3.6.0,<3.7.0)
Requires-Dist: numpy (>=1.24.0,<1.25.0)
Description-Content-Type: text/markdown

# MonteCarlo simulation algorithm

## Installation
`pip install montecarlosim`

## Requirements
Python 3.10.0+
Currently working to introduce support to old version.

## Getting started
- Clone the repository the way you like;
- Create a virtualenv (with pyenv and virtualenv you can run `pyenv virtualenv 3.10.0 <name_you_like>`) otherwise install poetry and run `poetry install`, it will take care of the virtualenv itself;
- Now you can lunch the tests with `poetry run tests` and it will tests all environment inside tox.ini `envlist`;
- Create a branch, do your changes, push them and open a PR.

## Repository structure
Repository configuration files are:
- `pyproject.toml`;
- `tox.ini`, tests;
- `src`, contains the actual repository code;
- `src/montecarlo.py`, contains the Montecarlo class (where magic happens);
- `src/functions.py`, contains example functions to be used with Montecarlo class;
- `src/exceptions.py`, contains custom exception that are used to better handle errors;
- `tests`, contains python tests file that is launched by tox;
- `run_tests.py`, simple function that run `subprocess.run('tox')`.
