Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Convert Documentation from reST to Markdown (#117)
Thanks, @mj023 !
- Loading branch information
Showing
37 changed files
with
897 additions
and
963 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
# Release Notes | ||
|
||
## v0.5 -- January 2022 | ||
|
||
- Move to plotly (#92, @timmens) | ||
- Cleaning up (@hmgaudecker) | ||
|
||
## v0.4 -- January 2021 | ||
|
||
- Move from Waf to Pytask (#86, @tobiasraabe, @hmgaudecker) | ||
- Move to GitHub Actions for CI (@janosg, WIP) | ||
|
||
## v0.3 -- October 2019 | ||
|
||
- Much improved documentation (@raholler) | ||
- Extensive instructions for use on Windows (@raholler) | ||
- Re-use previously-entered data when cookiecutter fails | ||
(@tobiasraabe, @raholler) | ||
- Fix Stata template by setting <span | ||
class="title-ref">--shell-escape=1</span> (#63, @raholler) | ||
- Add pyupgrade to pre-commit hooks (#59) | ||
- Thanks to students at LMU for pointing lots of this out! | ||
|
||
## v0.2 -- September 2019 | ||
|
||
- Full continuous integration testing on the Azure platform | ||
- R example completely working in Miniconda environment out of the | ||
box (@raholler) | ||
- Documentation for Stata / R examples (@raholler) | ||
- Much improved instructions for usage on Windows (@raholler) | ||
- Improved structure of docs | ||
|
||
## v0.1 -- October 2018 | ||
|
||
- First version with cookiecutter (thanks, @tobiasraabe | ||
and @julienschat) | ||
- All the stuff that accumulated over the years with the help of many. | ||
I wish my memory was better so I would be able to list the | ||
contributions separately. Thanks, @PKEuS, @philippmuller, | ||
@julienschat, @janosg, @tdrerup and many more who provided feedback! |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
# Templates for Reproducible Research Projects in Economics | ||
|
||
![MIT license](https://img.shields.io/github/license/OpenSourceEconomics/econ-project-templates) | ||
[![image](https://zenodo.org/badge/14557543.svg)](https://zenodo.org/badge/latestdoi/14557543) | ||
[![Documentation Status](https://readthedocs.org/projects/econ-project-templates/badge/?version=stable)](https://econ-project-templates.readthedocs.io/en/stable/) | ||
[![image](https://github.com/OpenSourceEconomics/econ-project-templates/actions/workflows/continuous-integration-workflow.yml/badge.svg)](https://github.com/OpenSourceEconomics/econ-project-templates/actions/workflows/continuous-integration-workflow.yml) | ||
[![image](https://codecov.io/gh/OpenSourceEconomics/econ-project-templates/branch/master/graph/badge.svg)](https://codecov.io/gh/OpenSourceEconomics/econ-project-templates) | ||
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/OpenSourceEconomics/econ-project-templates/master.svg)](https://results.pre-commit.ci/latest/github/OpenSourceEconomics/econ-project-templates/master) | ||
[![image](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) | ||
|
||
This project aims to provide project templates for economists that make it easy to | ||
produce reproducible research using one or more of the most frequently used programming | ||
languages in economics (i.e Python, R, Julia, Stata). | ||
|
||
Users and curious visitors please take a look at the | ||
[documentation](https://econ-project-templates.readthedocs.io/en/stable/). This | ||
repository is for developing the templates rather than using them. | ||
|
||
## Contributing | ||
|
||
We welcome suggestions on anything: improving the documentation, bug reports, feature | ||
requests. Please open an | ||
[issue](https://github.com/OpenSourceEconomics/econ-project-templates/issues) in these | ||
cases. | ||
|
||
If you want to work on a specific feature, we are more than happy to get you started! | ||
Please [get in touch briefly](https://www.wiwi.uni-bonn.de/gaudecker/personal_cv.html), | ||
this is a small team so there is no need for a detailed formal process. | ||
|
||
## Contributors | ||
|
||
@hmgaudecker @timmens @tobiasraabe | ||
|
||
## Former Contributors | ||
|
||
@janosg @PKEuS @philippmuller @julienschat @raholler |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
10 changes: 5 additions & 5 deletions
10
docs/source/background/design_rationale.rst → docs/source/background/design_rationale.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,12 +1,12 @@ | ||
The design of the project templates is guided by the following main thoughts: | ||
|
||
#. **Separation of logical chunks:** A minimal requirement for a project to scale. | ||
#. **Only execute required tasks, automatically:** Again required for scalability. It | ||
1. **Separation of logical chunks:** A minimal requirement for a project to scale. | ||
1. **Only execute required tasks, automatically:** Again required for scalability. It | ||
means that the machine needs to know what is meant by a "required task". | ||
#. **Re-use of code and data instead of copying and pasting:** Else you will forget the | ||
1. **Re-use of code and data instead of copying and pasting:** Else you will forget the | ||
copy & paste step at some point down the road. At best, this leads to errors; at | ||
worst, to misinterpreting the results. | ||
#. **Be as language-agnostic as possible:** Make it easy to use the best tool for a | ||
1. **Be as language-agnostic as possible:** Make it easy to use the best tool for a | ||
particular task and to mix tools in a project. | ||
#. **Separation of inputs and outputs:** Required to find your way around in a complex | ||
1. **Separation of inputs and outputs:** Required to find your way around in a complex | ||
project. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
(background)= | ||
|
||
# Background | ||
|
||
This section contains explanations on why the project templates look the way they do. | ||
This includes a short explanation of the content of the pre-installed example, the basic | ||
design rationale, discussion of the workflow, the directory structure we chose, and a | ||
little background on directed acyclic graphs and pytask. There is not much reference to | ||
code or a particular programming language here, this is relegated to the next section. | ||
|
||
(running_example)= | ||
|
||
## Running example | ||
|
||
```{include} running_example.md | ||
``` | ||
|
||
(design_rationale)= | ||
|
||
## Design Rationale | ||
|
||
```{include} design_rationale.md | ||
``` | ||
|
||
(workflow)= | ||
|
||
## How to Organize the Workflow? | ||
|
||
```{include} workflow.md | ||
``` | ||
|
||
(directory_structure)= | ||
|
||
## Directory Structure | ||
|
||
```{include} directory_structure.md | ||
``` | ||
|
||
(dag)= | ||
|
||
## Directed Acyclic Graphs | ||
|
||
```{include} dag.md | ||
``` | ||
|
||
(pytask)= | ||
|
||
## Introduction to pytask | ||
|
||
```{include} pytask.md | ||
``` |
Oops, something went wrong.