Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Hip otherinputs #283

Merged
merged 119 commits into from
Oct 13, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
119 commits
Select commit Hold shift + click to select a range
835a678
inital commit of openCL implementation
devincody Sep 16, 2019
f7d2c22
Somewhat working implementation of newtonian solver using pyopencl
devincody Sep 16, 2019
eb6d50f
(#138): Working OpenCL solver with ~6x speedup over python implementa…
devincody Sep 17, 2019
8f84c67
use opencl only if everything was setup properly
devincody Sep 22, 2019
9076f56
First commit of pycuda, working with ~5x speedup
devincody Sep 22, 2019
a56ee5c
(#138): Adding *.cu file this time
devincody Sep 22, 2019
fcba417
(#138): Defaults to gpu off, allocates gpu memory late
devincody Sep 23, 2019
8a05124
(#138): Renaming modules and variables
devincody Sep 23, 2019
447970b
(#138): CUDA Mikkola Solver now works
devincody Sep 23, 2019
c1a5e3d
(#138): Added default options at class level
devincody Oct 6, 2019
7d91b20
Merge branch 'main' into pycuda
sblunt Jan 25, 2021
a77b248
Updating Driver to accept stellar_mass instead of system_mass for con…
lhirsch238 Apr 2, 2021
8cebee3
Updated tutorials to reflect stellar_mass instead of system_mass term…
lhirsch238 Apr 2, 2021
561ac48
Changed stellar_mass to stellar_or_system_mass
Mireya-A May 28, 2021
2845019
small updates to mstar vs mtot
lhirsch238 Jul 21, 2021
f903eb1
merge with Mireya changes
lhirsch238 Jul 21, 2021
7912ab7
Merge branch 'develop' into pycuda
sblunt Sep 3, 2021
a29b107
Merge branch 'develop' into pycuda
sblunt Sep 3, 2021
a89328f
playing around with other input formats for IAD
sblunt Sep 16, 2021
6f247e9
first draft
sblunt Sep 21, 2021
48e132c
small changes to todo comments
sblunt Sep 21, 2021
9a8501b
now with correct math
sblunt Sep 21, 2021
4a0dc4e
now even with correct edr3 epoch!
sblunt Sep 21, 2021
c546492
now with working code!
sblunt Sep 21, 2021
b66358f
fixed some unit errors discovered with end-to-end bpic test
sblunt Sep 23, 2021
e8efcaf
asymptotically approaching reproducing eric's fit
sblunt Sep 26, 2021
4728fba
add dr2/dr3 option
sblunt Sep 26, 2021
fbdcab3
update hipparcos attribution
sblunt Sep 27, 2021
69e5b30
hipparcos module now handles 2021 re-reduction (which rejects scans) …
sblunt Sep 27, 2021
02a6740
remove .rr_headers in gitignore
sblunt Sep 27, 2021
b84bbe3
Merge branch 'hip-otherinputs' into gaia-module
sblunt Sep 27, 2021
2475600
formatting changelog in index docs
sblunt Sep 27, 2021
84c4c47
update todo list
sblunt Sep 27, 2021
5ad2023
adding the snellan RV to the beta pic end-to-end
sblunt Sep 27, 2021
94144c1
update beta pic test description
sblunt Sep 27, 2021
dba3be8
calculate absolute rather than relative log-likelihood
sblunt Sep 27, 2021
b2b76e6
alpha0 -> alpha0* in corner plot label
sblunt Sep 27, 2021
4e53b00
cite gaia appropriately
sblunt Sep 27, 2021
38d8ad6
add gaia to hipparcos tutorial
sblunt Sep 27, 2021
9bb4ebc
documenting gaia module more carefully
sblunt Sep 27, 2021
aa6efc9
undo absolute lnlike for gaia and hip
sblunt Sep 28, 2021
54777b4
add all unit tests for gaia
sblunt Sep 28, 2021
62c6040
Merge branch 'main' into mtot_mstar_consistency
sblunt Sep 28, 2021
5327750
api draft
sblunt Sep 29, 2021
6ffa663
Merge branch 'main' into plotting-api [skip-ci]
sblunt Sep 29, 2021
37645aa
tests passing [skip-ci]
sblunt Sep 29, 2021
748b2c0
some pep8 cleanup
sblunt Sep 29, 2021
cf22abb
hipparcos/gaia save/load tests passing
sblunt Sep 29, 2021
c4ce737
updated docstrings for all major modules
sblunt Sep 29, 2021
f3b6137
only running gpu tests when a gpu environment is detected
devincody Oct 3, 2021
3435c9c
Merge branch 'main' of github.com:sblunt/orbitize into pycuda
devincody Oct 3, 2021
7d6e783
Move gpu variables/functions to gpu context class which manages inter…
devincody Oct 3, 2021
e7e7075
reorganizing code, adding newton wrapper
devincody Oct 3, 2021
0181d72
moving profiling code to its own function, printing summaries instead…
devincody Oct 3, 2021
8dfe0d3
only import gpu_context if pycuda is installed properly
devincody Oct 3, 2021
4f33303
removing python2.7, pedagogical fluff
devincody Oct 3, 2021
c325f56
Adding info about WSL and windows-curses
devincody Oct 3, 2021
ba7bf1e
spelling
devincody Oct 3, 2021
8eccb4f
removing opencl files
devincody Oct 3, 2021
0c41c79
Docstrings, readability things, obeying pep8
devincody Oct 3, 2021
d78f4ea
more formatting, docstring updates
devincody Oct 3, 2021
fce61c9
Changed basis.param_idx statements to basis.standard_basis.idx to gra…
TirthDS Oct 4, 2021
2fcf0c0
add some unit tests and docs notes for secondary RVs
sblunt Oct 5, 2021
20beac3
prettifying docs html display
sblunt Oct 5, 2021
dd86230
add contributing page to main index
sblunt Oct 5, 2021
c76f3b2
added detail and example of fixing priors
sblunt Oct 6, 2021
314c47c
more small html changes
sblunt Oct 6, 2021
8def28c
and some more html changes
sblunt Oct 6, 2021
4f6547e
Merge branch 'plotting-api' into pycuda
sblunt Oct 7, 2021
f4c81db
Merge pull request #203 from sblunt/pycuda
sblunt Oct 7, 2021
7d22603
Fixed results and plotting with the new basis. Will need to add tests…
TirthDS Oct 7, 2021
173e31b
Merge branch 'main' into mtot_mstar_consistency
sblunt Oct 7, 2021
747838c
Merge remote-tracking branch 'origin/plotting-api' into mtot_mstar_co…
sblunt Oct 7, 2021
4f90cc3
fixed bug with MCMC version save/load with chopping chains
sblunt Oct 7, 2021
7cbfddb
fix m1 unit display on corner plot
sblunt Oct 7, 2021
4320a62
Merge remote-tracking branch 'origin/docs-facelift' into mtot_mstar_c…
sblunt Oct 7, 2021
02bf082
fixed a bug plotting data for multibody fits
sblunt Oct 7, 2021
4276e1f
bugfixes for orbit plot with no RV inst names
sblunt Oct 8, 2021
15752be
all notebooks running except changing bases
sblunt Oct 8, 2021
51b657e
Merge branch 'mtot_mstar_consistency' into basis_fix
sblunt Oct 8, 2021
243415c
save input_table rather than data_table so reloading works properly; …
sblunt Oct 8, 2021
9887e36
minor changes
sblunt Oct 8, 2021
8886259
fix import error
sblunt Oct 8, 2021
ca2960f
stellar_mass -> stellar_or_system_mass
sblunt Oct 8, 2021
607e1ef
missed one
sblunt Oct 8, 2021
30dff0c
make test_driver tests pass
sblunt Oct 8, 2021
733ceb9
make test_basis_with_system tests pass
sblunt Oct 8, 2021
2126d23
fix multi-inst rv plotting
sblunt Oct 8, 2021
cc68531
well now I did
sblunt Oct 8, 2021
41046d6
fixed mcmc tests; all tests pass now on my machine
sblunt Oct 8, 2021
47dc202
rerun all tutorials
sblunt Oct 8, 2021
925ae9f
Hip measurements are relative to 1991.25, so need to subtract orbit m…
sblunt Oct 11, 2021
5bb3d0d
cleanup
sblunt Oct 11, 2021
1748ee2
fix one sphere point re: mirek brandt
sblunt Oct 11, 2021
7eefe1f
remove debugging test from hipparcos.py
sblunt Oct 12, 2021
72d3677
add note about not fitting pm in gaia module
sblunt Oct 12, 2021
38cb1a9
Merge branch 'plotting-api' into docs-facelift
sblunt Oct 12, 2021
11a85a4
Merge branch 'docs-facelift' into mtot_mstar_consistency
sblunt Oct 12, 2021
fe7e646
add some more detail for windows install intructions
sblunt Oct 12, 2021
4281c6c
add some more detail for windows install instructions
sblunt Oct 12, 2021
a3d2128
formatting fix
sblunt Oct 12, 2021
4724bdb
add tutorial section captions
sblunt Oct 12, 2021
fa82d1f
added captions but didn't seem to change display
sblunt Oct 12, 2021
bf533f5
Merge branch 'docs-facelift' into mtot_mstar_consistency
sblunt Oct 13, 2021
629bcc1
Merge pull request #299 from sblunt/amend-windows-install-instructions
sblunt Oct 13, 2021
245ef27
Merge pull request #297 from sblunt/hipparcos-calculation-bugfix
sblunt Oct 13, 2021
4757161
Merge pull request #293 from sblunt/add-pl-rv-unit-tests
sblunt Oct 13, 2021
57a0243
Merge branch 'mtot_mstar_consistency' into basis_fix
sblunt Oct 13, 2021
7e323a8
Merge pull request #296 from sblunt/basis_fix
sblunt Oct 13, 2021
2993aa8
Merge pull request #294 from sblunt/docs-facelift
sblunt Oct 13, 2021
aede7c2
Merge pull request #286 from sblunt/mtot_mstar_consistency
sblunt Oct 13, 2021
c4c56f2
Merge branch 'gaia-module' into plotting-api
sblunt Oct 13, 2021
feed609
Merge pull request #287 from sblunt/plotting-api
sblunt Oct 13, 2021
4678db2
Merge pull request #285 from sblunt/gaia-module
sblunt Oct 13, 2021
f01e099
rerun tutorial nbs
sblunt Oct 13, 2021
e4b63a7
re-run tutorial nbs
sblunt Oct 13, 2021
7744d9f
use overwritable globbal variables instead of keywords to use c or gp…
sblunt Oct 13, 2021
2f811c6
fixing profiling tests
sblunt Oct 13, 2021
2570dbf
Merge pull request #300 from sblunt/cuda-c-api-cleanup
semaphoreP Oct 13, 2021
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,14 @@ Detailed API Documentation
.. toctree::
:titlesonly:

basis
driver
gaia
hipparcos
kepler
lnlike
nbody
plot
priors
read_input
results
Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
html_static_path = []

# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
Expand Down
11 changes: 11 additions & 0 deletions docs/contributing.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
Contributing to the Code
========================

``orbitize`` is under active development, and we've still got a lot to do! To get involved,
check out our `contributor guidelines <https://github.com/sblunt/orbitize/blob/master/contributor_guidelines.md>`_,
look over our `issues list <https://github.com/sblunt/orbitize/issues>`_, and/or reach out to
`Sarah <https://sites.google.com/g.harvard.edu/sarah/contact?authuser=0>`_. We'd love to have
you on our team!

Members of our team have collectively drafted `this community agreement <https://docs.google.com/document/d/1ZzjkoB20vVTlg2wbNpS7sRjmcSrECdh8kQ11-waZQhw/edit>`_ stating both our values and ground rules.
In joining our team, we ask that you read and (optionally) suggest changes to this document.
8 changes: 0 additions & 8 deletions docs/conversions.rst

This file was deleted.

8 changes: 8 additions & 0 deletions docs/gaia.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
.. _gaia:

Gaia API Module
===============
.. module:: orbitize

.. automodule:: orbitize.gaia
:members:
24 changes: 5 additions & 19 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,8 @@ Attribution:
* If you use the OFTI algorithm, please also cite `Blunt et al (2017) <https://ui.adsabs.harvard.edu/#abs/2017AJ....153..229B/abstract>`_.
* If you use the Affine-invariant MCMC algorithm from ``emcee``, please also cite `Foreman-Mackey et al (2013) <https://ui.adsabs.harvard.edu/abs/2013PASP..125..306F/abstract>`_.
* If you use the parallel-tempered Affine-invariant MCMC algorithm from ``ptemcee``, please also cite `Vousden et al (2016) <https://ui.adsabs.harvard.edu/abs/2016MNRAS.455.1919V/abstract>`_.
* If you use the Hipparcos intermediate astrometric data (IAD) fitting capability, please also cite `Nielsen et al (2020) <https://ui.adsabs.harvard.edu/abs/2020AJ....159...71N/abstract>`_.
* If you use the Hipparcos intermediate astrometric data (IAD) fitting capability, please also cite `Nielsen et al (2020) <https://ui.adsabs.harvard.edu/abs/2020AJ....159...71N/abstract>`_ and `van Leeuwen et al (2007) <https://ui.adsabs.harvard.edu/abs/2007A%26A...474..653V/abstract>`_.
* If you use Gaia data, please also cite `Gaia Collaboration et al (2018; for DR2) <https://ui.adsabs.harvard.edu/abs/2018A%26A...616A...1G/abstract>`_, or `Gaia Collaboration et al (2021; for eDR3) <https://ui.adsabs.harvard.edu/abs/2021A%26A...649A...1G/abstract>`_.


User Guide:
Expand All @@ -47,26 +48,9 @@ User Guide:
installation
tutorials
faq
contributing
api

Contributing:
+++++++++++++

``orbitize`` is under active development, and we've still got a lot to do! To get involved,
check out our `contributor guidelines <https://github.com/sblunt/orbitize/blob/master/contributor_guidelines.md>`_,
look over our `issues list <https://github.com/sblunt/orbitize/issues>`_, and/or reach out to
`Sarah <https://sites.google.com/g.harvard.edu/sarah/contact?authuser=0>`_. We'd love to have
you on our team!

Members of our team have collectively drafted `this community agreement <https://docs.google.com/document/d/1ZzjkoB20vVTlg2wbNpS7sRjmcSrECdh8kQ11-waZQhw/edit>`_ stating both our values and ground rules.
In joining our team, we ask that you read and (optionally) suggest changes to this document.


**Some major planned updates:**

* fit Gaia astrometry
* marginalize over instrumental uncertainties

Changelog:
++++++++++

Expand All @@ -75,6 +59,7 @@ Changelog:
This is the beta release of orbitize! version 2.

Big changes:

- N-body Kepler solver backend! (@sofiacovarrubias)
- Fitting in XYZ orbital basis! (@rferrerc)
- API for fitting in arbitrary new orbital bases! (@TirthDS)
Expand All @@ -84,6 +69,7 @@ Big changes:
- KDE prior added (inspiration=training on RV fits) (@jorgellop)

Small changes:

- HD 4747 rv data file fix for the RV tutorial (@lhirsch238)
- Add check_prior_support to sampler.MCMC (@adj-smith)
- Update example generation code in MCMC v OFTI tutorial (@semaphoreP)
Expand Down
34 changes: 33 additions & 1 deletion docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,16 @@ to learn more about ``conda`` virtual environments.
For Windows Users
+++++++++++++++++

There is a bug with the ``ptemcee`` installation that, as far as we know, only affects Windows users.
Many of the packages that we use in ``orbitize`` were originally written for Linux or macOS.
For that reason, we highly recommend installing the
`Windows Subsystem for Linux (WSL) <https://docs.microsoft.com/en-us/windows/wsl/about>`_
which is an entire Linux development environment within Windows. See `here <https://github.com/semaphoreP/codeastro/blob/main/Day0/INSTALL_WINDOWS.md#windows-subsystem-for-linux-wsl>`_
for a handy getting started guide.

If you don't want to use WSL, there are a few extra steps you'll need to follow
to get ``orbitize`` running:

1. There is a bug with the ``ptemcee`` installation that, as far as we know, only affects Windows users.
To work around this, download ``ptemcee`` from `its pypi page <https://pypi.org/project/ptemcee/>`_.
Navigate to the root ``ptemcee`` folder, remove the ``README.md`` file, then install:

Expand All @@ -45,6 +54,29 @@ Navigate to the root ``ptemcee`` folder, remove the ``README.md`` file, then ins
$ rm README.md
$ pip install . --upgrade

2. Some users have reported issues with installing ``curses``. If this happens to you, you can install
``windows-curses`` which should work as a replacement.

.. code-block:: bash

$ pip install windows-curses

3. Finally, ``rebound`` is not compatible with windows, so you'll need to git clone
orbitize, remove rebound from orbitize/requirements.txt, then install from
the command line.

.. code-block:: bash

$ git clone https://github.com/sblunt/orbitize.git
$ cd orbitize

Open up orbitize/requirements.txt, remove ``rebound``, and save.

.. code-block:: bash

$ pip install . --upgrade


For Developers
++++++++++++++

Expand Down
8 changes: 8 additions & 0 deletions docs/nbody.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
.. _nbody:

N-body Backend
===============
.. module:: orbitize

.. automodule:: orbitize.nbody
:members:
8 changes: 8 additions & 0 deletions docs/plot.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
.. _plot:

Plotting Methods
================
.. module:: orbitize

.. automodule:: orbitize.plot
:members:
25 changes: 17 additions & 8 deletions docs/tutorials.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,11 @@ For an advanced plotting demo, see "Advanced Plotting," and to learn
about the differences between OFTI and MCMC algorithms,
we suggest "MCMC vs OFTI Comparison."

We also have a bunch of tutorials designed to introduce you to specific features
of our code, listed below.

Many of these tutorials are also available as jupyter notebooks
`here <https://github.com/sblunt/orbitize/tree/master/docs>`_.
`here <https://github.com/sblunt/orbitize/tree/main/docs/tutorials>`_.

If you find a bug, or if something is unclear, please create an issue
on GitHub! We'd love any feedback on how to make ``orbitize`` more
Expand All @@ -25,27 +28,33 @@ style of using and explaining the code. If you are confused by part of
one tutorial, we suggest looking at some of the others (and then contacting
us if you are still confused).

**Basic Tutorials:**

.. toctree::
:maxdepth: 1
:caption: Basic Tutorials

tutorials/Quick-Start.ipynb
formatting_inputs
tutorials/OFTI_tutorial.ipynb
tutorials/MCMC_tutorial.ipynb

**Advanced Tutorials:**

.. toctree::
:maxdepth: 1
:caption: Advanced Tutorials

tutorials/RV_MCMC_Tutorial.ipynb
tutorials/Multiplanet_Tutorial.ipynb
tutorials/Modifying_Priors.ipynb
tutorials/Using_nonOrbitize_Posteriors_as_Priors.ipynb
tutorials/Plotting_tutorial.ipynb
tutorials/MCMC_vs_OFTI.ipynb
tutorials/Modifying_MCMC_initial_positions.ipynb

.. toctree::
:maxdepth: 1
:caption: Feature Tutorials

tutorials/RV_MCMC_Tutorial.ipynb
tutorials/Multiplanet_Tutorial.ipynb
tutorials/Using_nonOrbitize_Posteriors_as_Priors.ipynb
tutorials/Changing_bases_tutorial.ipynb
tutorials/Hipparcos_IAD.ipynb



Loading