Skip to content

Latest commit

 

History

History
92 lines (65 loc) · 4.75 KB

README.md

File metadata and controls

92 lines (65 loc) · 4.75 KB

banner

THOR

Tracklet-less Heliocentric Orbit Recovery

Python 3.9+ License DOI
docker - Build, Lint, and Test conda - Build, Lint, and Test pip - Build, Lint, Test, and Coverage
pre-commit Coverage Status Docker Pulls
Anaconda-Server Badge Anaconda-Server Badge Anaconda-Server Badge

Warning: THOR is still in very active development.

The latest "stable" version is v1.2. The code on the main branch is currently being used to develop THOR v2.0 and is not guaranteed to be stable. We anticipate that v2.0 will be the one most useful to the community and we aim for it to be released by the end of 2023. THOR v2.0 is a complete re-write of the THOR code primarily designed to enable it for use as a service on the Asteroid, Discovery, Analysis and Mapping (ADAM) platform. The primary goal of v2.0 is to enable THOR to work at scale on many small cloud-hosted VMs. The secondary goal of v2.0 is to add changes that will work towards enabling the linking of NEOs (THOR is currently configured to work on the Main Belt and outwards).

Installation

The corresponding notebook repository can be found at: https://github.com/moeyensj/thor_notebooks

The following installation paths are available:
Anaconda
Docker
Source

Anaconda

thor can be downloaded directly from anaconda:
conda install -c moeyensj thor

Or, if preferred, installed into its own environment via:
conda create -n thor_py38 -c moeyensj thor python=3.8

Docker

A Docker container with the latest version of the code can be pulled using:

docker pull moeyensj/thor:latest

To run the container:

docker run -it moeyensj/thor:latest

The THOR code is installed the /projects directory, and is by default also installed in the container's Python installation. To access the code in Python:

(base) root@202110177eee:/# python
Python 3.6.9 |Anaconda, Inc.| (default, Jul 30 2019, 19:07:31)
[GCC 7.3.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> import thor
>>>

Source

Clone this repository using either ssh or https. Once cloned and downloaded, cd into the repository.

To install THOR in its own conda enviroment please do the following:

conda create -n thor_py38 -c defaults -c conda-forge -c astropy -c moeyensj --file requirements.txt python=3.8

Or, to install THOR in a pre-existing conda environment called env:

conda activate env
conda install -c defaults -c conda-forge -c astropy -c moeyensj --file requirements.txt

Once pre-requisites have been installed using either one of the options above, then:

python setup.py install

Or, if you are actively planning to develop or contribute to THOR, then:

python setup.py develop --no-deps

You should now be able to start Python and import THOR.

┌─(thor_py38)[moeyensj][±][main ✓][~/projects/thor]
└─▪ python
Python 3.8.8 (default, Apr 13 2021, 19:58:26)
[GCC 7.3.0] :: Anaconda, Inc. on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> import thor
>>>

If you would like to run Jupyter Notebook or Juptyter Lab with THOR please see the installation instructions in the THOR notebooks repository.