Skip to content

Commit

Permalink
update readme, remove orbitize dependency now
Browse files Browse the repository at this point in the history
  • Loading branch information
wbalmer committed Dec 21, 2023
1 parent 56f39a9 commit ea4a625
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 8 deletions.
3 changes: 3 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"esbonio.sphinx.confDir": ""
}
8 changes: 4 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
*backtracks*
============
backtracks
==========

.. image:: https://img.shields.io/pypi/v/backtracks
:target: https://pypi.python.org/pypi/backtracks
Expand All @@ -13,7 +13,7 @@
.. image:: https://img.shields.io/github/license/wbalmer/backtracks
:target: https://github.com/wbalmer/backtracks/blob/main/LICENSE

:stars: Python package to fit relative astrometry with background helical motion tracks, to discern directly imaged planets :ringed_planet: from contaminant sources.
Python package to fit relative astrometry with background helical motion tracks, to discern directly imaged planets :ringed_planet: from contaminant sources :stars:

Written by Gilles Otten (@gotten), William Balmer (@wbalmer), and Tomas Stolker (@tomasstolker).

Expand All @@ -40,7 +40,7 @@ Log-likelihood and some utility functions borrowed heavily from `orbitize!` (BSD
Installation
============

Currently requires and python 3.9 ish and `astropy`, `corner`, `dynesty`, `matplotlib`, `numpy`, `novas`, `novas_de405`, `orbitize` and their dependencies. Note that `novas` is not supported on Windows. You can create a working environment using conda+pip via a few lines of code:
Currently requires and python 3.9 ish and `astropy`, `corner`, `dynesty`, `matplotlib`, `numpy`, `novas`, `novas_de405`, and their dependencies. Note that `novas` is not supported on Windows. (but W.B. uses WSL to develop this code, and would recommend it!) You can create a working environment using conda+pip via a few lines of code:

.. code-block:: console
Expand Down
2 changes: 1 addition & 1 deletion docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Installation
============

Currently requires and python 3.9 ish and `astropy`, `corner`, `dynesty`, `matplotlib`, `numpy`, `novas`, `novas_de405`, `orbitize` and their dependencies. Note that `novas` is not supported on Windows. You can create a working environment using conda+pip via a few lines of code:
Currently requires and python 3.9 ish and `astropy`, `corner`, `dynesty`, `matplotlib`, `numpy`, `novas`, `novas_de405`, and their dependencies. Note that `novas` is not supported on Windows. You can create a working environment using conda+pip via a few lines of code:

.. code-block:: console
Expand Down
4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -23,5 +23,5 @@ classifiers = [
dependencies = { file = ["requirements.txt"] }

[project.urls]
Homepage = "https://github.com/wbalmer/backtrack"
Issues = "https://github.com/wbalmer/backtrack/issues"
Homepage = "https://github.com/wbalmer/backtracks"
Issues = "https://github.com/wbalmer/backtracks/issues"
1 change: 0 additions & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ matplotlib
numpy
novas
novas_de405
orbitize
pandas
seaborn
schwimmbad
Expand Down

0 comments on commit ea4a625

Please sign in to comment.