Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
AaronDavidSchneider committed Nov 22, 2023
1 parent aedf949 commit cd944b9
Showing 1 changed file with 86 additions and 7 deletions.
93 changes: 86 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# chemcomp

Modeling the chemical composition of gas giants by accretion of pebbles, planetesimals and gas.

## Usage:
If you use this code in your work and found it useful, please cite [Schneider & Bitsch (2021a)](https://ui.adsabs.harvard.edu/abs/2021A&A...654A..71S)
**docs: [WIKI](https://chemcomp.readthedocs.io/en/latest/ "wiki")**

## install:
clone project:
Expand All @@ -17,16 +17,95 @@ Install conda environment:

`conda create -n chemcomp numpy "astropy>=4.0" scipy matplotlib pyyaml jupyter parse h5py pip pytables`

Install `chemcomp`:
Install a development version `chemcomp`:

`pip install -e .`

or install from pypi

``pip install chemcomp``

Adjust paths in `chemcomp/helper/main_helper` if you need different directories for output and config.

## Publications
### Original Publications

-

[Schneider & Bitsch (2021a)](https://ui.adsabs.harvard.edu/abs/2021A&A...654A..71S)

: How drifting and evaporating pebbles shape giant planets. I.
Heavy element content and atmospheric C/O

-

[Schneider & Bitsch (2021b)](https://ui.adsabs.harvard.edu/abs/2021A&A...654A..72SS)

: How drifting and evaporating pebbles shape giant planets. II.
Volatiles and refractories in atmospheres

-

[Bitsch, Schneider & Kreidberg (2022)](https://ui.adsabs.harvard.edu/abs/2022A&A...665A.138B)

: How drifting and evaporating pebbles shape giant planets. III.
The formation of WASP-77A b and $\tau$ Boötis b

Please cite [Schneider & Bitsch(2021a)](https://ui.adsabs.harvard.edu/abs/2021A&A...654A..71S), if you use `chemcomp` in your work.

### Publications using `chemcomp`

-

[Bitsch et al. (2021)](https://ui.adsabs.harvard.edu/abs/2021A&A...649L...5B)

: Dry or water world? How the water contents of inner sub-Neptunes
constrain giant planet formation and the location of the water
ice line

-

[Hühn & Bitsch (2023)](https://ui.adsabs.harvard.edu/abs/2023A&A...676A..87H)

: How accretion of planet-forming disks influences stellar
abundances

-

[Bitsch & Mah (2023)](https://ui.adsabs.harvard.edu/abs/2023arXiv230900509B)

: Enriching inner discs and giant planets with heavy elements

-

[Mah & Bitsch (2023a)](https://ui.adsabs.harvard.edu/abs/2023A&A...673A..17M)

: Forming super-Mercuries: Role of stellar abundances

-

[Mah & Bitsch (2023b)](https://ui.adsabs.harvard.edu/abs/2023A&A...677L...7M)

: Close-in ice lines and the super-stellar C/O ratio in discs
around very low-mass stars

-

[Savvidou & Bitsch (2023)](https://ui.adsabs.harvard.edu/abs/2023arXiv230903807S)

: How to make giant planets via pebble accretion

-

[Danti, Bitsch & Mah (2023)](https://ui.adsabs.harvard.edu/abs/2023arXiv231002886D)

: Composition of giant planets: the roles of pebbles and
planetesimals

And several more in preperation (last updated: 22.11.2023)


## Thanks:
- I would like to thank Bertram Bitsch for his enormous support during the development of this code and for continuing to use the code together with his students.
- I would like to thank Cornelis Dullemond for providing the solver which (in adapted version) is used to solve the gas viscous disk equation and dust transport equation.
- I would like to thank everyone, who has already used chemcomp in their work and has contributed in fixing small bugs.

## Help:
Check the [WIKI](https://chemcomp.readthedocs.io/en/latest/ "wiki")
- I would like to thank everyone, who has already used chemcomp in their work and has contributed in fixing small bugs.

0 comments on commit cd944b9

Please sign in to comment.