Installation
Requirements
Ammonyte requires Python ≥ 3.10.
Dependencies
The following packages are installed automatically with Ammonyte:
pyleoclim >= 1.2.1scipy >= 1.15.3numpy >= 1.26.4PyRQA >= 8.1.0scikit-learn >= 1.7.0ruptures >= 1.1.10
Install from PyPI
pip install ammonyteInstall from source
git clone https://github.com/LinkedEarth/Ammonyte.git
cd Ammonyte
pip install -e .Conda environment (recommended)
A pre-configured environment file is provided in .binder/environment.yml:
conda env create -f .binder/environment.yml
conda activate ammonyte_envVerify the installation
After installing, confirm the package is available and check the version:
import ammonyte
print(ammonyte.__version__)Running the tests
Install pytest and run the test suite from the root of the repository:
pip install pytest
pytest ammonyte/tests/