Skip to content

Commit

Permalink
README update
Browse files Browse the repository at this point in the history
  • Loading branch information
HajimeKawahara committed Dec 24, 2024
1 parent 166d8a0 commit 9e6702f
Showing 1 changed file with 15 additions and 12 deletions.
27 changes: 15 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,33 +2,35 @@
[![License](https://img.shields.io/github/license/HajimeKawahara/exojax)](https://github.com/HajimeKawahara/exojax/blob/develop/LICENSE)
[![Docs](https://img.shields.io/badge/docs-exojax-brightgreen)](http://secondearths.sakura.ne.jp/exojax/)
[![arxiv](https://img.shields.io/badge/arxiv-2105.14782-blue)](http://arxiv.org/abs/2105.14782)
[![arxiv](https://img.shields.io/badge/arxiv-2410.06900-blue)](https://arxiv.org/abs/2410.06900)
[![paper](https://img.shields.io/badge/paper-ApJS_258_31_(2022)-orange)](https://iopscience.iop.org/article/10.3847/1538-4365/ac3b4d)
<a href="https://codeclimate.com/github/HajimeKawahara/exojax/maintainability"><img src="https://api.codeclimate.com/v1/badges/97c5e8835f3ef9c4ad7c/maintainability" /></a>

Differentiable spectral modelling of exoplanets/brown dwarfs/M dwarfs using JAX!
Read [the docs](http://secondearths.sakura.ne.jp/exojax/develop) 🐕.
Differentiable spectral modelling of exoplanets/brown dwarfs/M dwarfs using [JAX](https://github.com/jax-ml/jax)!
Read [the docs](http://secondearths.sakura.ne.jp/exojax) 🐕.
In short, ExoJAX allows you to do gradient based optimizations, HMC-NUTS, and SVI using the latest database.

ExoJAX is at least compatible with

- PPLs: [NumPyro](https://github.com/pyro-ppl/numpyro), [blackjax](https://github.com/blackjax-devs/blackjax), [bayeux](https://github.com/jax-ml/bayeux)
- Optimizers: [JAXopt](https://github.com/google/jaxopt), [optax](https://github.com/google-deepmind/optax)
- Optimizers: [Optax](https://github.com/google-deepmind/optax), [JAXopt](https://github.com/google/jaxopt)

<img src="https://github.com/user-attachments/assets/70d4291b-f818-4204-ab96-b3bd6c99c48f" Titie="exojax" Width=850px>

<details><summary>ExoJAX Classes</summary>

- Databases: *db (mdb: molecular, adb: atomic, cdb:continuum, pdb: particulates)
- Opacity Calculators: opa (Voigt profile, CIA, Mie, Rayleigh scattering etc)
- Atmospheric Radiative Transfer: art (emission w, w/o scattering, refelction, transmission)
- Spectral Operator: sop (planet rotation, instrumental boradening)
- Atompsheric Microphysics: amp (clouds etc)
- Opacity Calculators: opa (Voigt profile, CIA, Mie/Rayleigh scattering etc)
- Atmospheric Radiative Transfer: art (emission w, w/o scattering, reflection, transmission)
- Spectral Operator: sop (planet rotation, instrumental broadening)
- Atmospheric Microphysics: amp (clouds etc)
- GPU-memory efficient Layer-by-layer opacity and transfer computations: opart

</details>

## Get Started

See [this page](http://secondearths.sakura.ne.jp/exojax/develop/tutorials/get_started.html) for the first step!
See [this page](http://secondearths.sakura.ne.jp/exojax/tutorials/get_started.html) for the first step!

## Real Examples (external)

Expand All @@ -37,13 +39,14 @@ See [this page](http://secondearths.sakura.ne.jp/exojax/develop/tutorials/get_st


## References
[![paper](https://img.shields.io/badge/paper_I-ApJS_258_31_(2022)-orange)](https://iopscience.iop.org/article/10.3847/1538-4365/ac3b4d)

[![paper I](https://img.shields.io/badge/paper_I-ApJS_258_31_(2022)-orange)](https://iopscience.iop.org/article/10.3847/1538-4365/ac3b4d)
[![paper II](https://img.shields.io/badge/arxiv-2410.06900-blue)](https://arxiv.org/abs/2410.06900)

- Paper I: Kawahara, Kawashima, Masuda, Crossfield, Pannier, van den Bekerom, [ApJS 258, 31 (2022)](https://iopscience.iop.org/article/10.3847/1538-4365/ac3b4d)
- Paper II: in prep
- Paper II: Kawahara, Kawashima, Tada et al. [AAS under review](https://arxiv.org/abs/2410.06900)



## License

🐈 Copyright 2020-2024 ExoJAX contributors. ExoJAX is publicly available under the MIT license.
🐈 Copyright 2020-2025 ExoJAX contributors. ExoJAX is publicly available under the MIT license.

0 comments on commit 9e6702f

Please sign in to comment.