# REPO_NAME

This repository contains SHORT_DESCRIPTION.

[![GitHub issues](https://img.shields.io/github/issues/USERNAME/REPO_NAME.svg)](https://github.com/USERNAME/REPO_NAME/issues)
[![GitHub forks](https://img.shields.io/github/forks/USERNAME/REPO_NAME.svg)](https://github.com/USERNAME/REPO_NAME/network)
[![GitHub stars](https://img.shields.io/github/stars/USERNAME/REPO_NAME.svg)](https://github.com/USERNAME/REPO_NAME/stargazers)
[![Code license](https://img.shields.io/github/license/USERNAME/REPO_NAME.svg)](https://github.com/USERNAME/REPO_NAME/blob/main/LICENSE-AGPL.md)
[![Data license](https://img.shields.io/github/license/USERNAME/REPO_NAME.svg)](https://github.com/USERNAME/REPO_NAME/blob/main/LICENSE-CCBY.md)
[![DOI](https://zenodo.org/badge/GITHUB_REPO_ID.svg)](https://zenodo.org/badge/latestdoi/ZENODO_RECORD)

## Overview

TODO: Describe what the project documents in 3 to 5 sentences. State the intended audience, the main data products, and anything users should know before reusing the data.

## Data At A Glance

| Item                | Description                                                     |
| ------------------- | --------------------------------------------------------------- |
| Main data           | TODO: name the central dataset or output                        |
| Coverage            | TODO: temporal, geographic, thematic, or source coverage        |
| Unit of observation | TODO: person, place, event, document, measurement, record, etc. |
| Sources             | TODO: original sources or collection method                     |
| Formats             | TODO: CSV, JSON, GeoJSON, Parquet, images, text, etc.           |
| Data license        | [CC BY 4.0](LICENSE-CCBY.md), unless changed                    |
| Code license        | [AGPL 3.0](LICENSE-AGPL.md), unless changed                     |
| Citation            | See [CITATION.cff](CITATION.cff) and the Zenodo DOI             |

## Repository Structure

The repository follows the [Advanced Structure for Data Analysis](https://book.the-turing-way.org/project-design/pd-overview/project-repo/project-repo-advanced/) from _The Turing Way_.

| Path                  | Purpose                                      |
| --------------------- | -------------------------------------------- |
| `data/`               | Data files and data documentation            |
| `documentation/`      | Methods, data dictionaries, and user guides  |
| `analysis/`           | Notebooks and analysis scripts               |
| `src/`                | Code for collection, processing, or analysis |
| `test/`               | Tests for data and code                      |
| `assets/`             | Images and media                             |
| `project-management/` | Roles, decisions, meetings, and reports      |

## Reuse

1. Read the project website: <https://USERNAME.github.io/REPO_NAME/>.
2. Check `documentation/` for methods, field definitions, and known limitations.
3. Use files in `data/` according to the data license.
4. Cite the project using [CITATION.cff](CITATION.cff) or the Zenodo DOI.

Clone the repository if you want the full project history and code:

```bash
git clone https://github.com/USERNAME/REPO_NAME.git
```

## Citation

If you use this project, cite it as described in [CITATION.cff](CITATION.cff). Archived releases and citation exports are available on [Zenodo](https://zenodo.org/record/ZENODO_RECORD) after the first release.

## Support

This project is maintained by [@USERNAME](https://github.com/USERNAME). Please use public channels when possible so answers remain findable for others.

| Type                                   | Platform                                                                |
| -------------------------------------- | ----------------------------------------------------------------------- |
| 🚨 **Bug reports**                     | [GitHub Issues](https://github.com/USERNAME/REPO_NAME/issues)           |
| 📊 **Report bad data**                 | [GitHub Issues](https://github.com/USERNAME/REPO_NAME/issues)           |
| 📚 **Docs issues**                     | [GitHub Issues](https://github.com/USERNAME/REPO_NAME/issues)           |
| 🎁 **Feature requests**                | [GitHub Issues](https://github.com/USERNAME/REPO_NAME/issues)           |
| 🛡 **Report a security vulnerability** | See [SECURITY.md](SECURITY.md)                                          |
| 💬 **General questions**               | [GitHub Discussions](https://github.com/USERNAME/REPO_NAME/discussions) |
| 🔒 **Private project contact**         | [INSERT CONTACT METHOD]                                                 |

## Contributing

Corrections, data issues, documentation improvements, and reuse examples are welcome. Please read [CONTRIBUTING.md](CONTRIBUTING.md) before opening a pull request.

## Versioning

Versions are listed in the [repository tags](https://github.com/USERNAME/REPO_NAME/tags) and archived releases are listed on [Zenodo](https://zenodo.org/record/ZENODO_RECORD).

## Authors And Acknowledgment

- **FULLNAME** - _Initial work_ - [USERNAME](https://github.com/USERNAME)

See the [contributors page](https://github.com/USERNAME/REPO_NAME/graphs/contributors) for additional contributions.

## License

Data are released under [CC BY 4.0](LICENSE-CCBY.md). Code is released under [AGPL 3.0](LICENSE-AGPL.md).