Commit 17186163 authored by marbaix's avatar marbaix
Browse files

Update of the README file to add a reference to Zommers et al. 2020 and...

Update of the README file to add a reference to Zommers et al. 2020 and simplify / clarify some parts of the text.
parent 9a141cdc
Pipeline #376112 passed with stage
in 27 seconds
......@@ -7,9 +7,8 @@ The purpose of this software is to (re)produce burning ember diagrams of the sty
An example is figure 2 from the Summary for Policymakers of the
Special Report on a global warming of 1.5°C:
[SR15 Figure SPM.2](https://www.ipcc.ch/site/assets/uploads/sites/2/2019/02/SPM2-1003x1024.png).
Please note that this software is not a product of the IPCC: the IPCC is not responsible for projects or researches.
No figure published by the IPCC to date (05/2020) was made with this software, but the ability of this software to
reproduce several figures published by the IPCC was carefully tested.
Please note that this software is not a product of the IPCC; the IPCC is not responsible for projects or researches.
The ability of this software to reproduce several figures (previously) published by the IPCC was carefully tested.
How to use
----------
......@@ -43,24 +42,24 @@ Version numbers
The main version number is increased with every change to any part of The Ember Factory,
(emberweb and embermaker, see above). The main version number is in emberweb/__init__.py
Embermaker also has its own version number (in embermaker/__init__.py), so as to indicate changes
that might influence the 'product', ie. burning ember diagrams.
that might influence the 'product', ie. burning ember diagrams. However, our objective is to avoid any change
that would alter the reproduction of older figures, and tests are done before new releases to check that.
Development history
-------------------
This software was created by philippe.marbaix -at- uclouvain.be at the end of 2019.
The first objective was to produce a figure for a paper that is now under review (05/2020).
The first objective was to produce figure 3 of Zommers et al. 2020 ([doi.org/10/gg985p](https://doi.org/10/gg985p)).
While I have a long experience of coding in a range of programming languages, this is
my first experience with a web application. I made efforts in order to have
a structure that can be understood and potentially extended in the future, but I guess that it
may be improved. In addition, the coding logic and structure was first designed to be used
with mod_python (which is obsolete) and then revised in 2020 to work with Flask.
Therefore some aspects of the coding may still follow the logic of this earlier version rather
than what would have been done for an application designed for Flask in the first place.
The work for this project was done outside of my duties at UCLouvain, which are related to the
[Plateforme wallonne pour le GIEC](https://plateforme-wallonne-giec.be), and represent 80% of my work time.
a structure that can be understood and potentially extended in the future. Improvements were
regularly provided during 2020 and this will likely continue if there are needs.
Some aspects of the coding may still reflect the logic of the first versions rather than
what would be done if starting from sratch; changes are done when they become useful, as experience
also drives further development. Any feedback is thus very helpful!
The work for this project is done outside of my duties for the
[Plateforme wallonne pour le GIEC](https://plateforme-wallonne-giec.be).
Help is welcome to further improve the application, but I have no experience in collaborative
software development so please be patient. All contributions will be recognised :-).
Help is welcome to further improve the application. All contributions will be recognised :-).
No tracking by Google or anyone else
------------------------------------
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment