sea-names 0.1.2

Installation

This project relies on conda for installation and managing of the project dependencies.

1. Download and install miniconda for your operating system https://docs.conda.io/en/latest/miniconda.html.

2. Clone this project with git.

3. Once conda is available build the environment for this project with:

   conda env create -f environment.yml

   The above command creates a new conda environment titled sea-names with the necessary project dependencies.

4. An Additional environment file is present for testing and development environments. The additional developer dependencies can be installed with:

   conda env update -f test-environment.yml

5. To install the project to the new environment:

   conda activate sea-names
   pip install -e .

Running Tests

To run the project’s tests:

pytest -sv --integration

Usage

Configuration

Building with Docker

To build the docker container:

docker build -t sea-names .

Running with Docker

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

0.1.0 (2023-06-16)

• First release on PyPI.