Science Score: 59.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 11 DOI reference(s) in README -
✓Academic publication links
Links to: zenodo.org -
✓Committers with academic emails
1 of 6 committers (16.7%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (14.5%) to scientific vocabulary
Keywords from Contributors
Repository
Finite-amplitude Impulse Response simple climate model
Basic Info
- Host: GitHub
- Owner: OMS-NetZero
- License: apache-2.0
- Language: Python
- Default Branch: master
- Homepage: https://docs.fairmodel.net
- Size: 58.7 MB
Statistics
- Stars: 144
- Watchers: 7
- Forks: 77
- Open Issues: 25
- Releases: 36
Metadata Files
README.md
FaIR
FaIR (the Finite-amplitude Impulse-Response) climate model is a simple climate model, or emulator, useful for producing global mean temperature projections from a wide range of emissions or prescribed forcing scenarios.
Requirements
- python 3.8, 3.9, 3.10, 3.11, 3.12 or 3.13
Installation
From anaconda (recommended)
NEW! from v2.1.4, fair is available on conda-forge:
conda install -c conda-forge fair
Older versions of fair (1.6.2+, 2.1.0-4) can be installed from the chrisroadmap channel:
conda install -c chrisroadmap fair==X.Y.Z
From the Python Package Index
pip install fair
From source
Refer to the documentation
Usage
FaIR can be driven by emissions of greenhouse gases (GHGs) and short-lived forcers (SLCFs), concentrations of GHGs, or effective radiative forcing (ERF), with different input methods for different species possible in the same run. If run concentration-driven, emissions are back-calculated. Custom GHGs and SLCFs can be defined, and all components are optional allowing experiments such as pulse-response analyses to single forcers or gathering up non-CO~2~ species as an aggregate forcing.
Examples
The examples directory contains Jupyter notebooks with some simple examples showing how to run FaIR and the standalone energy balance model.
If you want to try this out online, go here.
Important: A note about calibrating and constraining
FaIR is naive. It will run whatever climate scenario and climate configuration you give it. If you violate the laws of physics, FaIR won\'t stop you. For simple climate models as for complex, garbage in leads to garbage out. More subtle to spot are those analyses with simple climate models where the present day warming (or historical) is wrong or the climate is warming too slowly or too quickly. At least, plot a historical temperature reconstruction over your results and see if it looks right.
We have produced IPCC AR6 Working Group 1 consistent probabilistic ensembles to run with. The calibration data can be obtained here. These parameter sets are calibrated to CMIP6 models, run in a large Monte Carlo ensemble, and constrained based on observed and assessed climate metrics. For an example of how to use this calibration data set with SSP emissions, see this example. If you\'re writing a paper using FaIR, you should use these. A paper describing this method has been submitted, but for now please cite the Zenodo DOI.
Citation
If you use FaIR in your work, please cite the following references depending on the version:
- v2.0+: Leach, N. J., Jenkins, S., Nicholls, Z., Smith, C. J., Lynch, J., Cain, M., Walsh, T., Wu, B., Tsutsui, J., and Allen, M. R.: FaIRv2.0.0: a generalized impulse response model for climate uncertainty and future scenario exploration, Geosci. Model Dev., 14, 3007--3036, https://doi.org/10.5194/gmd-14-3007-2021, 2021
- v1.1-v1.6: Smith, C. J., Forster, P. M., Allen, M., Leach, N., Millar, R. J., Passerello, G. A., and Regayre, L. A.: FAIR v1.3: A simple emissions-based impulse response and carbon cycle model, Geosci. Model Dev., https://doi.org/10.5194/gmd-11-2273-2018, 2018.
- v1.0 (or the concept of the state-dependent impulse-response function for CO2): Millar, R. J., Nicholls, Z. R., Friedlingstein, P., and Allen, M. R.: A modified impulse-response representation of the global near-surface air temperature and atmospheric concentration response to carbon dioxide emissions, Atmos. Chem. Phys., 17, 7213-7228, https://doi.org/10.5194/acp-17-7213-2017, 2017.
Owner
- Name: OMS-NetZero
- Login: OMS-NetZero
- Kind: organization
- Repositories: 4
- Profile: https://github.com/OMS-NetZero
GitHub Events
Total
- Create event: 7
- Release event: 2
- Issues event: 9
- Watch event: 16
- Delete event: 4
- Member event: 1
- Issue comment event: 8
- Push event: 8
- Pull request event: 6
- Fork event: 14
Last Year
- Create event: 7
- Release event: 2
- Issues event: 9
- Watch event: 16
- Delete event: 4
- Member event: 1
- Issue comment event: 8
- Push event: 8
- Pull request event: 6
- Fork event: 14
Committers
Last synced: 7 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Chris Smith | c****p@g****m | 510 |
| Zebedee Nicholls | z****s@c****g | 23 |
| Robert Gieseke | r****e@p****e | 21 |
| James Penn | j****s@j****k | 3 |
| Sally | s****e@g****m | 2 |
| Robert Gieseke | r****g@w****e | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 71
- Total pull requests: 104
- Average time to close issues: about 1 year
- Average time to close pull requests: 2 months
- Total issue authors: 17
- Total pull request authors: 8
- Average comments per issue: 1.97
- Average comments per pull request: 1.72
- Merged pull requests: 92
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 7
- Pull requests: 4
- Average time to close issues: 6 days
- Average time to close pull requests: 7 minutes
- Issue authors: 4
- Pull request authors: 2
- Average comments per issue: 0.43
- Average comments per pull request: 0.75
- Merged pull requests: 3
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- chrisroadmap (36)
- znicholls (9)
- rgieseke (6)
- TeddyHornsby (2)
- Hans-PeterH (2)
- fracamil (2)
- milankl (1)
- saraarriz (1)
- duncanwp (1)
- cccccwendy (1)
- FrankErrickson (1)
- lgloege (1)
- colemanmr (1)
- dyrehaugen (1)
- Yifeng2016 (1)
Pull Request Authors
- chrisroadmap (85)
- rgieseke (13)
- znicholls (8)
- SallyDa (4)
- JGBroadbent (3)
- nsfmc (1)
- chrisdwells (1)
- jamesp (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 2,281 last-month
- Total docker downloads: 278
- Total dependent packages: 3
- Total dependent repositories: 13
- Total versions: 41
- Total maintainers: 4
pypi.org: fair
Finite-amplitude Impulse Response (FaIR) simple climate model
- Homepage: https://github.com/OMS-NetZero/FAIR
- Documentation: https://fair.readthedocs.io/
- License: Apache 2.0
-
Latest release: 2.2.2
published over 1 year ago
Rankings
Maintainers (4)
Dependencies
- actions/checkout v3 composite
- actions/setup-python v3 composite
- codecov/codecov-action v3 composite