Skip to main content

Version GPL Python unit tests) C unit tests DOI

ASSIST

ASSIST is a software package for ephemeris-quality integrations of test particles. ASSIST is an extension of the REBOUND framework and makes use of its IAS15 integrator to integrate test particle trajectories in the field of the Sun, Moon, planets, and 16 massive asteroids, with the positions of the masses coming from the JPL DE441 ephemeris and its associated asteroid perturber file. The package incorporates the most significant gravitational harmonics and general relativistic corrections. ASSIST also accounts for position- and velocity-dependent non-gravitational effects according to the Marsden (1973) model. All components in the equations of motion have been verified to machine precision in a term-by-term comparison with output from JPL's small body integrator. The first order variational equations are included for all terms to support orbit fitting and covariance mapping. This framework is meant to provide an open-source package written in a modern language to enable high-precision orbital analysis and science by the small body community.

Installation (Python)

It's easiest to install ASSIST into a python virtual environment. If you already have a virtual environment or do not want to use one, you can skip this step. Otherwise, run the following command in an empty directory. They will setup and activate a new virtual environment in a directory.

python3 -m venv venv
source venv/bin/activate

Now we can install numpy, REBOUND, and ASSIST:

pip install numpy
pip install rebound 
pip install assist

To use use ASSIST, you also need to download ephemeris data files. One file for planet ephemeris and another suplementary file for asteroid ephemeris. You can do this with Python packages or by downloading files directly. Note that these are large files, almost 1GB in size.

pip install naif-de440
pip install jpl-small-bodies-de441-n16

You can initialize the ephemeris data from the packages like so:

python3

>>> import assist
>>> from naif_de440 import de440
>>> from jpl_small_bodies_de441_n16 import de441_n16
>>> ephem = assist.Ephem(de440, de441_n16)

The variables to the ephemeris files are simply path strings to the files. Alternatively, you can download these files with curl or your browser.

mkdir data
curl https://ssd.jpl.nasa.gov/ftp/eph/planets/bsp/de440.bsp -o data/de440.bsp
curl https://ssd.jpl.nasa.gov/ftp/eph/small_bodies/asteroids_de441/sb441-n16.bsp -o data/sb441-n16.bsp

Now you can point assist to those files directly, like so:

python3

>>> import assist
>>> ephem = assist.Ephem("data/de440.bsp", "data/sb441-n16.bsp")

Once you've initialized the ephemeris data, you can test that assist is working by running the following commands:

>>> print(ephem.jd_ref)
>>> ephem.get_particle("Earth", 0)

You should see the default reference Julian date (2451545.0) and the position of the Earth at that time printed on the screen.

Installation (C)

To install the C version of ASSIST, first clone the REBOUND and then the ASSIST repositories. In an empty directory, run:

git clone https://github.com/hannorein/rebound.git
git clone https://github.com/matthewholman/assist.git

To use use ASSIST, you also need to download ephemeris data files. One file for planet ephemeris and another suplementary file for asteroid ephemeris. The following commands download these files with curl. You can also manually download them using your browser. Note that these are large files, almost 1GB in size.

curl https://ssd.jpl.nasa.gov/ftp/eph/planets/bsp/de440.bsp -o assist/data/de440.bsp
curl https://ssd.jpl.nasa.gov/ftp/eph/small_bodies/asteroids_de441/sb441-n16.bsp -o assist/data/sb441-n16.bsp

For some of the examples, you will also need the planet ephemeris file with an extended coverage. Note that this file is 2.6GB in size.

curl https://ssd.jpl.nasa.gov/ftp/eph/planets/bsp/de441.bsp -o assist/data/de441.bsp

Next, go to one of the example directories and compile the problem file. This will also trigger the installation of the REBOUND and ASSIST shared libraries.

cd assist/examples/asteroid
make

Now, you're ready to run the example with:

./rebound

License

ASSIST is open source, freely distributed under the GNU General Public license, version 3.

Contributors

  • Matthew J. Holman, Center for Astrophysics | Harvard & Smithsonian, mholman@cfa.harvard.edu
  • Arya Akmal, Montgomery College, Rockville
  • Davide Farnocchia, Jet Propulsion Laboratory, California Institute of Technology
  • Hanno Rein, University of Toronto, hanno@hanno-rein.de
  • Matthew J. Payne, Center for Astrophysics | Harvard & Smithsonian
  • Robert Weryk, University of Western Ontario
  • Dan Tamayo, Harvey Mudd College, dtamayo@hmc.edu
  • David M. Hernandez, Center for Astrophysics | Harvard & Smithsonian
  • Alec Koumjian, Asteroid Institute | B612 Foundation, alec@b612foundation.org

Metadata

Release files for assist-adam-fork 1.1.9.post1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for assist-adam-fork 1.1.9.post1
File Size Uploaded
assist_adam_fork-1.1.9.post1.tar.gz 47.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for assist-adam-fork 1.1.9.post1
File Interpreter ABI Platform
assist_adam_fork-1.1.9.post1-cp313-cp313-macosx_14_0_arm64.whl CPython 3.13 CPython 3.13 macOS 14.0+ ARM64 Details

Total release size: 92.7 kB

Release files / assist_adam_fork-1.1.9.post1.tar.gz

Download URL assist_adam_fork-1.1.9.post1.tar.gz
Size 47.4 kB
Tags Source
SHA-256 checksum
How to use checksums
9d6230ae27b13867a8c48956f1b6c45aa2c945949ef79d007e711f91f621e905
BLAKE2b-256 checksum
How to use checksums
f7110979b7a885a060804dd1ea339e9c1a6e24c8fc38d8cf872eff38c6f9532b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.3

Release files / assist_adam_fork-1.1.9.post1-cp313-cp313-macosx_14_0_arm64.whl

Download URL assist_adam_fork-1.1.9.post1-cp313-cp313-macosx_14_0_arm64.whl
Size 45.2 kB
Tags CPython 3.13 macOS 14.0+ ARM64
SHA-256 checksum
How to use checksums
0c908026cf0b0799499560543400b1eea763f9fdbc3a5d1d12e65d5391392ff6
BLAKE2b-256 checksum
How to use checksums
b6766e1e747fc2a020e444094dc4267507f352e470c38c7a7b28af816ceb0935
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.3

Release history Release notifications | RSS feed

This release

1.1.9.post1 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page