Metadata-Version: 2.4
Name: SnoScience
Version: 2.0.2
Summary: A package optimised for building small neural networks fast.
License: MIT
Author: Max Snoodijk
Author-email: max_snoodijk@live.nl
Maintainer: Max Snoodijk
Maintainer-email: max_snoodijk@live.nl
Requires-Python: >=3.10,<3.13
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: numpy (>=2.2,<3.0)
Project-URL: Documentation, https://thesecondsnomax.github.io/SnoScience/
Project-URL: Repository, https://dev.azure.com/snomax/SnoScience
Description-Content-Type: text/markdown

# SnoScience

The source code, documentation, and CI/CD scripts for the SnoScience package are stored in this repository.

### Installation

1. Clone the repository with the following command:

```shell
git clone https://snomax@dev.azure.com/snomax/SnoScience/_git/SnoScience
```

2. Create a virtual environment and activate it.

3. Install poetry:

```shell
pip install poetry
```

4. Install the package with 'dev' and 'docs' dependency groups:

```shell
poetry install --with dev,docs
```

Optionally, add the 'validate' dependency group to install Tensorflow and Matplotlib. 

### Documentation

All documentation related to the usage and development of the SnoScience package can be found [here](https://thesecondsnomax.github.io/SnoScience/).

