Installation

Requirements

The project requires:

  • Python 3.10 or higher.

  • Git.

  • TensorFlow.

  • Pandas.

  • NumPy.

  • Scikit-learn.

  • Joblib.

  • Typer.

  • Loguru.

  • Sphinx, if the documentation needs to be built locally.

Installing package

uvx --from asteroid-impact-sdoml asteroid-demo

Clone the repository

git clone https://github.com/altamirano146080/asteroid_impact.git
cd asteroid_impact

Using uv

The repository includes pyproject.toml and uv.lock.

If uv is installed, synchronize the project dependencies with:

uv sync

Activate the virtual environment if necessary:

source .venv/bin/activate

Using venv

Create a virtual environment:

python -m venv .venv

On Linux or macOS, activate it with:

source .venv/bin/activate

On Windows, activate it with:

.venv\Scripts\activate

Install the project:

pip install -e .

Building the documentation

Move to the documentation directory:

cd docs

Build the HTML documentation:

make html

The generated documentation will be available at:

docs/_build/html/index.html