Skip to content

Commit e277c02

Browse files
authored
Merge pull request #1 from ClimateImpactLab/cmip6_scenarios
Cmip6 scenarios
2 parents 997fb82 + 6337c40 commit e277c02

File tree

7 files changed

+2932
-98
lines changed

7 files changed

+2932
-98
lines changed

MANIFEST.in

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ include versioneer.py
22
include fair/_version.py
33
graft fair/SSPs/data
44
graft fair/RCPs/data
5+
graft fair/Scenario/data
56
graft fair/tools/tcrecs
67
prune tests*
78
prune docs*

README.rst

Lines changed: 3 additions & 85 deletions
Original file line numberDiff line numberDiff line change
@@ -1,82 +1,12 @@
1-
| |Build Status|
2-
| |Binder|
3-
| |Docs Status|
4-
| |Zenodo|
5-
| |Codecov|
6-
71
FaIR
82
====
93

104
Finite Amplitude Impulse-Response simple climate-carbon-cycle model
115

12-
Installation
13-
------------
14-
15-
#. Make sure you have Python 3.6+ and pip installed
16-
#. From terminal/command prompt ``pip install fair``
17-
18-
Usage
19-
-----
20-
21-
FaIR takes emissions of greenhouse gases, aerosol and ozone precursors,
22-
and converts these into greenhouse gas concentrations, radiative forcing
23-
and temperature change.
24-
25-
There are two ways to run FaIR:
26-
27-
#. Carbon dioxide emissions only with all other radiative forcings
28-
specified externally (specify ``useMultigas=False`` in the call to
29-
``fair_scm``);
30-
#. All species included in the RCP emissions datasets, with, optionally,
31-
solar and volcanic forcing still specified externally. For
32-
convenience, the RCP datasets are provided in the RCP subdirectory
33-
and can be imported:
34-
35-
::
6+
This repo is a fork of the FAIR model maintained by the Climate Impact Lab for use in research and publications. For the official version of the FAIR model, see https://github.com/OMS-NetZero/FAIR.
367

37-
from fair.forward import fair_scm
38-
from fair.RCPs import rcp85
39-
emissions = rcp85.Emissions.emissions
40-
C,F,T = fair_scm(emissions=emissions)
41-
42-
The main engine of the model is the ``fair_scm`` function in
43-
``forward.py``. This function can be imported into a Python script or
44-
iPython session. The most important keyword to ``fair_scm`` is the
45-
``emissions``. This should be either a (nt, 40) numpy array (in multigas
46-
mode) or (nt,) numpy array (in CO2 only mode), where nt is the number of
47-
model timesteps. The outputs are a tuple of ``(C, F, T)`` arrays which
48-
are GHG concentrations ((nt, 31) in multigas mode, (nt,) in CO2-only
49-
mode), forcing ((nt, 13) or (nt,)) and temperature change (nt,). The
50-
index numbers corresponding to each species will be given in tables 1 to
51-
3 of the revised version of the Smith et al. paper reference below (we
52-
hope to make this object-oriented in the future). For now, note that the
53-
input emissions follow the ordering of the RCP datasets, which are
54-
included under ``fair/RCPs``, and the GHG concentrations output are in
55-
the same order, except that we don't output the year, only use one
56-
column for total CO2, and the short-lived species (input indices 5 to 11
57-
inclusive) are not included, reducing the number of columns from 40 to
58-
31. In multigas mode the forcing output indices are:
59-
60-
0. CO\ :sub:`2`\
61-
1. CH\ :sub:`4`\
62-
2. N\ :sub:`2`\ O
63-
3. Minor GHGs (CFCs, HFCs etc)
64-
4. Tropospheric ozone
65-
5. Stratospheric ozone
66-
6. Stratospheric water vapour from methane oxidation
67-
7. Contrails
68-
8. Aerosols
69-
9. Black carbon on snow
70-
10. Land use
71-
11. Volcanic
72-
12. Solar
73-
74-
75-
For further information, see the example ipython notebook contained in
76-
the GitHub repo at https://github.com/OMS-NetZero/FAIR.
77-
78-
References:
79-
-----------
8+
FAIR Model References:
9+
---------------------
8010

8111
Smith, C. J., Forster, P. M., Allen, M., Leach, N., Millar, R. J.,
8212
Passerello, G. A., and Regayre, L. A.: FAIR v1.3: A simple
@@ -88,15 +18,3 @@ modified impulse-response representation of the global near-surface air
8818
temperature and atmospheric concentration response to carbon dioxide
8919
emissions, Atmos. Chem. Phys., 17, 7213-7228,
9020
https://doi.org/10.5194/acp-17-7213-2017, 2017.
91-
92-
.. |Build Status| image:: https://travis-ci.org/OMS-NetZero/FAIR.svg?branch=master
93-
:target: https://travis-ci.org/OMS-NetZero/FAIR
94-
.. |Binder| image:: https://mybinder.org/badge.svg
95-
:target: https://mybinder.org/v2/gh/OMS-NetZero/FAIR/master?filepath=notebooks/Example-Usage.ipynb
96-
.. |Docs Status| image:: https://readthedocs.org/projects/fair/badge/?version=latest
97-
:target: http://fair.readthedocs.io/en/latest/?badge=latest
98-
:alt: Documentation Status
99-
.. |Zenodo| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.1247898.svg
100-
:target: https://doi.org/10.5281/zenodo.1247898
101-
.. |Codecov| image:: https://codecov.io/gh/OMS-NetZero/FAIR/branch/master/graph/badge.svg
102-
:target: https://codecov.io/gh/OMS-NetZero/FAIR

fair/Scenario/__init__.py

Whitespace-only changes.

0 commit comments

Comments
 (0)