Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add more info to readme #30

Merged
merged 8 commits into from
Oct 20, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 36 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,26 @@
# wp2_atlas
# Atlas of constrained climate projections- EUCP WP2

## Build Setup
This repository contains the source code and content for an [Atlas of constrained climate projections](https://eucp-project.github.io/atlas/). The atlas demonstrates outputs from the probabilistic projection methods developed or assessed in the [European Climate Projection system](https://www.eucp-project.eu/) (EUCP)
Horizon2020 project. For more info, see the [Atlas about page](https://eucp-project.github.io/atlas/about).

## Citation

To cite this repository, use the information avialable at [FIXME](FIXME),
and to cite the content of the Atlas, see the [Atlas references page]FIXME.

## Maintainers

Current maintainers of the Atlas are Research software engineers from the
[Netherlands eScience Center](https://www.esciencecenter.nl/).
If you have any questions or concerns, please submit an
[issue](https://github.com/eucp-project/atlas/issues). Maintainers will do their
best to help you.

## Contributing

The atlas is created with [Nuxt.js](https://nuxtjs.org/docs/get-started/installation). This section provides instructions for adding maps to Atlas.

1. Create a local build of the application

```bash
# install dependencies
Expand All @@ -17,4 +37,17 @@ $ npm run start
$ npm run generate
```

For detailed explanation on how things work, check out [Nuxt.js docs](https://nuxtjs.org).
For detailed explanations on how things work, check out [Nuxt.js docs](https://nuxtjs.org).

2. Add maps

The maps shown in Atlas are created using the data available at [FIXME](FIXME),
and are stored in `png` format in `assets` directory of this repository. The
Python scripts to process the data and to create the maps are stored in `python`
directory. Read more [here](./python/README.md).
You can use the scripts as examples to develp a new script for your own data.
Then add new maps and scripts by submitting a new [pull request](https://github.com/eucp-project/atlas/pulls).

## Acknowledgement

FIXME