deepSKA
About
:warning: This package is currently under construction and in pre-release. The API and features may change suddenly without warning.
Project Team
Vanessa Graber (vanessa.graber@rhul.ac.uk)
Getting Started
Prerequisites
deepska requires Python 3.11.
Installation
We recommend installing in a project specific virtual environment created using
a environment management tool such as
Conda. To install the latest
development version of deepska using pip in the currently active
environment run
pip install git+https://github.com/NSs-FLF-RHUL/deepska.git
Alternatively create a local clone of the repository with
git clone https://github.com/NSs-FLF-RHUL/deepska.git
and then install in editable mode by running
pip install -e .
Running Locally
Running Tests
Tests can be run across all compatible Python versions in isolated environments
using tox by running
tox
To run tests manually in a Python environment with pytest installed run
pytest tests
again from the root of the repository.
Building Documentation
The MkDocs HTML documentation can be built locally by running
tox -e docs
from the root of the repository. The built documentation will be written to
site.
Alternatively to build and preview the documentation locally, in a Python
environment with the optional docs dependencies installed, run
mkdocs serve