Merge pull request #21 from wbalmer/dev-wb

0.3.1 to fix files in pypi

README.md

@@ -3,8 +3,6 @@ Python package to fit relative astrometry with background star motion tracks.
 
 Written by Gilles Otten (@gotten), William Balmer (@wbalmer), and Tomas Stolker (@tomasstolker).
 
-Work in progress, as of Jun. 15th, 2023.
-
 eDR3 Distance prior summary file from this [source](https://arxiv.org/pdf/2012.05220.pdf), published in [Bailer-Jones+2021](https://arxiv.org/abs/2012.05220).
 
 Current example (HD131399Ab) uses data from Wagner+22 and Nielsen+17. Thank you to Kevin Wagner for providing the latest astrometry!
@@ -13,6 +11,22 @@ Log-likelihood borrowed heavily from `orbitize!` (BSD 3-clause).
 
 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:
 
+```
+conda create python=3.9 -n backtrack
+conda activate backtrack
+conda install pip
+pip install backtracks
+```
+
+Then, download the test data+script and test your installation (takes a while to sample fully):
+```
+wget https://raw.githubusercontent.com/wbalmer/backtrack/main/tests/scorpions1b_orbitizelike.csv
+wget https://raw.githubusercontent.com/wbalmer/backtrack/main/tests/hd131339a.py
+python hd131339a.py
+```
+
+or, to clone the repo and install in development mode (we recommend this, as the code is a work in progress and you can easily fix bugs you will likely encounter this way):
+
 ```
 conda create python=3.9 -n backtrack
 conda activate backtrack

pyproject.toml

@@ -1,10 +1,11 @@
 [build-system]
-requires = ["setuptools>=61.0"]
+requires = ["setuptools>=61.0",
+            "setuptools-scm>=8.0"]
 build-backend = "setuptools.build_meta"
 
 [project]
 name = "backtracks"
-version = "0.3.0"
+version = "0.3.1"
 authors = [
   { name="William Balmer", email="[email protected]" },
   { name="Gilles Otten", email="[email protected]" },
@@ -21,6 +22,9 @@ classifiers = [
 [tool.setuptools.dynamic]
 dependencies = { file = ["requirements.txt"] }
 
+[tool.setuptools.packages.find]
+where = ["src"]
+
 [project.urls]
 Homepage = "https://github.com/wbalmer/backtrack"
 Issues = "https://github.com/wbalmer/backtrack/issues"

src/backtracks.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: backtracks
-Version: 0.3.0
+Version: 0.3.1
 Summary: Python package to fit relative astrometry with background star motion tracks.
 Author-email: William Balmer <[email protected]>, Gilles Otten <[email protected]>, Tomas Stolker <[email protected]>
 Project-URL: Homepage, https://github.com/wbalmer/backtrack
@@ -28,8 +28,6 @@ Python package to fit relative astrometry with background star motion tracks.
 
 Written by Gilles Otten (@gotten), William Balmer (@wbalmer), and Tomas Stolker (@tomasstolker).
 
-Work in progress, as of Jun. 15th, 2023.
-
 eDR3 Distance prior summary file from this [source](https://arxiv.org/pdf/2012.05220.pdf), published in [Bailer-Jones+2021](https://arxiv.org/abs/2012.05220).
 
 Current example (HD131399Ab) uses data from Wagner+22 and Nielsen+17. Thank you to Kevin Wagner for providing the latest astrometry!
@@ -38,6 +36,22 @@ Log-likelihood borrowed heavily from `orbitize!` (BSD 3-clause).
 
 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:
 
+```
+conda create python=3.9 -n backtrack
+conda activate backtrack
+conda install pip
+pip install backtracks
+```
+
+Then, download the test data+script and test your installation (takes a while to sample fully):
+```
+wget https://raw.githubusercontent.com/wbalmer/backtrack/main/tests/scorpions1b_orbitizelike.csv
+wget https://raw.githubusercontent.com/wbalmer/backtrack/main/tests/hd131339a.py
+python hd131339a.py
+```
+
+or, to clone the repo and install in development mode (we recommend this, as the code is a work in progress and you can easily fix bugs you will likely encounter this way):
+
 ```
 conda create python=3.9 -n backtrack
 conda activate backtrack

src/backtracks.egg-info/SOURCES.txt

@@ -1,14 +1,32 @@
+.gitignore
+.pyproject.toml.swp
 LICENSE
 README.md
+dynesty.save
 pyproject.toml
 requirements.txt
+dist/backtracks-0.3.0-py3-none-any.whl
+dist/backtracks-0.3.0.tar.gz
 src/backtracks/__init__.py
 src/backtracks/backtrack.py
+src/backtracks/bailer-jones_edr3.csv
 src/backtracks/plotting.py
 src/backtracks/utils.py
 src/backtracks.egg-info/PKG-INFO
 src/backtracks.egg-info/SOURCES.txt
 src/backtracks.egg-info/dependency_links.txt
 src/backtracks.egg-info/requires.txt
 src/backtracks.egg-info/top_level.txt
+tests/HD_131399_A_bjprior_backtrack.pdf
+tests/HD_131399_A_corner_backtrack.pdf
+tests/HD_131399_A_dynestyrun_results.pkl
+tests/HD_131399_A_evidence_backtrack.pdf
+tests/HD_131399_A_model_backtrack_radec.pdf
+tests/HD_131399_A_model_backtrack_seppa.pdf
+tests/HD_131399_A_nearby_gaia_distribution.pdf
+tests/bailer-jones_edr3_prior_summary.csv
+tests/dynesty.save
+tests/gaia_query_6204835284262018688.fits
+tests/hd131339a.py
+tests/scorpions1b_orbitizelike.csv
 tests/test_plotting.py