Skip to content

Commit

Permalink
readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Nicholaswogan committed Oct 27, 2023
1 parent d5d971a commit a99211a
Showing 1 changed file with 21 additions and 9 deletions.
30 changes: 21 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,23 @@
# Clima

**NOTE: Clima has not been published in a peer-reviewed journal yet. Please do not use this model in a paper that will be published. Wait for me to publish the model first, so you are able to cite it. Email me if you have questions ([email protected])**

`Clima` is a radiative transfer code and a climate model. It is currently under construction.
`Clima` is a radiative transfer code and a climate model.

## Installation

### Conda

Clima is a module of the `photochem` package, which can be installed via conda:

`conda install -c conda-forge photochem`

You can then import `clima`.

```python
from photochem import clima
```

### From source

You need a Fortran compiler (`gfortran>=9.30`, [install instructions here](https://fortran-lang.org/learn/os_setup/install_gfortran)) and C compiler (e.g. install with `conda install -c conda-forge clang`)

Create a `conda` environment with all dependencies
Expand All @@ -30,11 +42,7 @@ python -m pip install --no-deps --no-build-isolation . -v

If your installation fails, and it is not clear why, please raise an issue.

## Contact

If you have questions email me: [email protected]

## Funding and Acknowledgements
## Funding, acknowledgements and publications

Funding for the development of Clima comes from
- [The Virtual Planetary Laboratory](https://depts.washington.edu/naivpl/content/welcome-virtual-planetary-laboratory)
Expand All @@ -48,4 +56,8 @@ This model was build in collaboration with
- Kevin Zahnle
- Eric Wolf
- Sandra Bastelberger
- Shawn Domagal-Goldman
- Shawn Domagal-Goldman

Publications that use clima
- [DOI: 10.3847/PSJ/aced83](https://doi.org/10.3847/PSJ/aced83)

0 comments on commit a99211a

Please sign in to comment.