The Ember Factory
=================
Objective
---------
The purpose of this software is to facilitate the (re)production of burning ember diagrams of the style used
in IPCC reports.
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).
The Ember Factory is a small web application ('the factory') that relies on the related
[EmberMaker](https://pypi.org/project/embermaker/) project
(...'the machine') to produce the diagrams. While the EmberFactory produces diagrams in just a few clicks,
[EmberMaker](https://pypi.org/project/embermaker/) can be integrated into other applications as a library.
The ability of this software to reproduce many of the figures published to date by the IPCC has been carefully tested
(however, the IPCC would not be responsible for any errors in this software).
How to use
----------
This software (hereafter 'the EF') is designed to work as a web application.
However, it is relatively easy to run it "locally":
- The application is publicly available here: https://climrisk.org/emberfactory
- To run it on your own computer, you need to have Python >= 3.10 installed, then install the EF with pip: `pip3 install emberfactory`
Then set the environment variable needed by flask: `export FLASK_APP=emberfactory` (for Windows: `$env:FLASK_APP = "emberfactory"`)
and start with `flask run`. You should receive an url to open in your browser and access the EF, such as for example
http://127.0.0.1:5000/
- To run the app on a server, you need a *WSGI server such as Gunicorn* (*not included* in the required packages
because you do not need it to run the EF locally, and you may have another WSGI server).
If you want a root path such as /emberfactory, the EF is written so that you should set this path
in the APPLICATION_ROOT variable within a file called emberfactory.cfg that needs to be
located in your /instance folder (this is not entirely standard).
Development history
-------------------
This software was created by philippe.marbaix -at- uclouvain.be at the end of 2019.
The first objective was to produce figure 3 of Zommers et al. 2020 ([doi.org/10/gg985p](https://doi.org/10/gg985p)).
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 scratch; changes are done when they become useful, as experience
also drives further development. Any feedback is thus very helpful!
Help is welcome to further improve the application. All contributions will be recognised :-).
No tracking
-----------
I am making efforts to avoid anything that could result in
user tracking: no fonts, icons or libraries downloaded from third-parties by the user.
I would like this to continue in the future. Advice would be welcome.
It is also why the code is hosted by [framasoft](https://framasoft.org) using [gitlab](https://gitlab.org).
I thank them both.
Raw data
{
"_id": null,
"home_page": "https://framagit.org/marbaix/ember-factory",
"name": "EmberFactory",
"maintainer": "Philippe Marbaix",
"docs_url": null,
"requires_python": "",
"maintainer_email": "philippe.marbaix@uclouvain.be",
"keywords": "",
"author": "Philippe Marbaix",
"author_email": "philippe.marbaix@uclouvain.be",
"download_url": "",
"platform": null,
"description": "The Ember Factory\n=================\n\nObjective\n---------\nThe purpose of this software is to facilitate the (re)production of burning ember diagrams of the style used \nin IPCC reports.\nAn example is figure 2 from the Summary for Policymakers of the \nSpecial Report on a global warming of 1.5\u00b0C: \n[SR15 Figure SPM.2](https://www.ipcc.ch/site/assets/uploads/sites/2/2019/02/SPM2-1003x1024.png). \n\nThe Ember Factory is a small web application ('the factory') that relies on the related \n[EmberMaker](https://pypi.org/project/embermaker/) project \n(...'the machine') to produce the diagrams. While the EmberFactory produces diagrams in just a few clicks,\n[EmberMaker](https://pypi.org/project/embermaker/) can be integrated into other applications as a library.\n\nThe ability of this software to reproduce many of the figures published to date by the IPCC has been carefully tested\n(however, the IPCC would not be responsible for any errors in this software).\n\nHow to use\n----------\nThis software (hereafter 'the EF') is designed to work as a web application. \nHowever, it is relatively easy to run it \"locally\":\n\n- The application is publicly available here: https://climrisk.org/emberfactory\n\n- To run it on your own computer, you need to have Python >= 3.10 installed, then install the EF with pip: `pip3 install emberfactory`\n Then set the environment variable needed by flask: `export FLASK_APP=emberfactory` (for Windows: `$env:FLASK_APP = \"emberfactory\"`) \n and start with `flask run`. You should receive an url to open in your browser and access the EF, such as for example\n http://127.0.0.1:5000/\n\n- To run the app on a server, you need a *WSGI server such as Gunicorn* (*not included* in the required packages\nbecause you do not need it to run the EF locally, and you may have another WSGI server). \nIf you want a root path such as /emberfactory, the EF is written so that you should set this path \nin the APPLICATION_ROOT variable within a file called emberfactory.cfg that needs to be\nlocated in your /instance folder (this is not entirely standard).\n\nDevelopment history\n-------------------\nThis software was created by philippe.marbaix -at- uclouvain.be at the end of 2019.\nThe first objective was to produce figure 3 of Zommers et al. 2020 ([doi.org/10/gg985p](https://doi.org/10/gg985p)).\nImprovements were regularly provided during 2020 and this will likely continue if there are needs. \nSome aspects of the coding may still reflect the logic of the first versions rather than \nwhat would be done if starting from scratch; changes are done when they become useful, as experience\nalso drives further development. Any feedback is thus very helpful!\n\nHelp is welcome to further improve the application. All contributions will be recognised :-).\n\nNo tracking\n-----------\nI am making efforts to avoid anything that could result in\nuser tracking: no fonts, icons or libraries downloaded from third-parties by the user.\nI would like this to continue in the future. Advice would be welcome.\nIt is also why the code is hosted by [framasoft](https://framasoft.org) using [gitlab](https://gitlab.org). \nI thank them both. \n",
"bugtrack_url": null,
"license": "GNU General Public License 3 or later",
"summary": "Software to (re)produce burning ember diagrams of the style used in IPCC reports.",
"version": "2.0.2",
"project_urls": {
"Homepage": "https://framagit.org/marbaix/ember-factory"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6782f2438de6b34ffe4341a177a817647d468673eb007308dd7b7686ee25bf3f",
"md5": "5382334d9cc75b94487b9d12f7e96bf2",
"sha256": "805044d127b00eb0b67cb53bdb246b75f705dfc809b94c25ae0262a03d455a4d"
},
"downloads": -1,
"filename": "EmberFactory-2.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5382334d9cc75b94487b9d12f7e96bf2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 1120156,
"upload_time": "2024-01-04T21:44:44",
"upload_time_iso_8601": "2024-01-04T21:44:44.047116Z",
"url": "https://files.pythonhosted.org/packages/67/82/f2438de6b34ffe4341a177a817647d468673eb007308dd7b7686ee25bf3f/EmberFactory-2.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-04 21:44:44",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "emberfactory"
}
JSON