Skip to content

Commit

Permalink
Fix docs Project.toml
Browse files Browse the repository at this point in the history
  • Loading branch information
sefffal committed Apr 6, 2023
1 parent e3a453d commit b591fd7
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 24 deletions.
31 changes: 15 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
# Octofitter.jl

Octofitter is a Julia package for performing Bayesian inference
against direct images of exoplanets, relative astrometry, astrometric acceleration
of the host star, and radial velocity (future).
Welcome to the documentation page for Octofitter.jl. This page includes tutorial and an API reference for using this package.

[![](https://img.shields.io/badge/docs-dev-blue.svg)](https://sefffal.github.io/Octofitter.jl/dev)
Octofitter is a Julia package for performing Bayesian inference against a wide variety of exoplanet / binary star data.

The package provides a simple but powerful modelling language which is used to generate efficient, differentiable code. You can then plug it into a variety of samplers. The package also contains analysis and visualization tools for understanding your results.

The package provides a simple but powerful modelling language which is used to generate
efficient, differentiable code for your system.
The package also contains analysis and visualization tools for understanding your results.
[![](https://img.shields.io/badge/docs-dev-blue.svg)](https://sefffal.github.io/Octofitter.jl/dev)

**Supported data:**
* sample directly from images
* sample directly from images and interferometric visibilities
* exoplanet astrometry
* stellar astrometric acceleration
* radial velocity
* experimental support for transit data based on Transits.jl

Any combination of the above.
Any and all combinations also work together.

**Modelling features:**
* multiple planets (one or more)
Expand All @@ -24,19 +24,18 @@ Any combination of the above.
* link mass to photometry via atmosphere models

**Speed:**
<p>Fit astrometry on your laptop in seconds!</p>

Fit astrometry on your laptop in minutes!

* Highly optimized code and derivatives are generated from your model
* Higher order sampler (No U-Turn sampler) which explores the parameter space very efficiently
* Run on a single core, multiple threads, or hundreds of nodes by changing just a single line of code

The package supports only bound, 2-body Keplerian orbits. Support for hyperbolic orbits and multi-body physics are not currently planned.
The package supports only bound, 2-body Keplerian orbits. Support for hyperbolic orbits and multi-body physics are not currently planned. Pull-requests to PlanetOrbits implementing this functionality would be welcome.

See also: the python libraries [Orbitize!](https://orbitize.readthedocs.io/en/latest/), [orvara](https://github.com/t-brandt/orvara), and [exoplanet](https://docs.exoplanet.codes/en/latest/).

See also: [Orbitize!](https://orbitize.readthedocs.io/en/latest/), [orvara](https://github.com/t-brandt/orvara), and [exoplanet](https://docs.exoplanet.codes/en/latest/).

For instructions, see the documentation page:

[![](https://img.shields.io/badge/docs-dev-blue.svg)](https://sefffal.github.io/Octofitter.jl/dev)

A particularily unique feature of this package is that you can model the flux and orbital motion of planets using a sequence of image(s) without any obvious detections. Using this tool, the SNR of a planet can grow with roughly the square root of the number of images. You can spot planets even if there is orbtial motion between the images, or constrain orbits using images with no detection.

![](images/readme-example.png)
15 changes: 7 additions & 8 deletions docs/Project.toml
Original file line number Diff line number Diff line change
@@ -1,15 +1,14 @@
[deps]
CairoMakie = "13f3f980-e62b-5c42-98c6-ff1f3baf88f0"
Distributions = "31c24e10-a181-5473-b8eb-7969acd0382f"
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
MCMCChains = "c7f686f2-ff18-58e9-bc7b-31028e88f75d"
PairPlots = "43a3c2be-4208-490b-832a-a21dcd55d7da"
Pkg = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f"
PlanetOrbits = "fd6f9641-d78f-43ce-a379-ceb0bddb468a"

using Octofitter, Distributions
using Random
using StatsBase
using MCMCChains
using Plots
using CairoMakie: Makie
using PairPlots
Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80"
Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
StatsBase = "2913bbd2-ae8a-5f71-8c99-4fb6c76f3a91"

[compat]
Documenter = "0.27"

0 comments on commit b591fd7

Please sign in to comment.