Skip to content

Commit

Permalink
"Recompile paper, add community guidelines for contributions"
Browse files Browse the repository at this point in the history
  • Loading branch information
julianbelina committed Feb 29, 2024
2 parents 07b649a + 428ae39 commit b45362d
Show file tree
Hide file tree
Showing 5 changed files with 70 additions and 3 deletions.
52 changes: 51 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,4 +83,54 @@ pytest

# Documentation

A ReadTheDocs Documentation can be found [here](https://ethospenalps.readthedocs.io/en/latest/Introduction.html).
A ReadTheDocs Documentation can be found [here](https://ethospenalps.readthedocs.io/en/latest/Introduction.html).


# Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit
helps, and credit will always be given.

You can contribute in many ways:

## Types of Contributions


### Report Bugs


Report bugs at https://github.com/FZJ-IEK3-VSA/ETHOS_PeNALPS/issues.

If you are reporting a bug, please include:

* Your operating system name and version.
* Any details about your local setup that might be helpful in troubleshooting.
* Detailed steps to reproduce the bug.

### Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with "bug" and "help
wanted" is open to whoever wants to implement it.

### Implement Features

Look through the GitHub issues for features. Anything tagged with "enhancement"
and "help wanted" is open to whoever wants to implement it.

### Write Documentation

ETHOS.PeNALPS could always use more documentation, whether as part of the
official ETHOS.PeNALPS docs, in docstrings, or even on the web in blog posts,
articles, and such.

### Submit Feedback


The best way to send feedback is to file an issue at https://github.com/FZJ-IEK3-VSA/ETHOS_PeNALPS/issues.

If you are proposing a feature:

- Explain in detail how it would work.
- Keep the scope as narrow as possible, to make it easier to implement.
- Remember that this is a volunteer-driven project, and that contributions
are welcome :)
11 changes: 10 additions & 1 deletion paper/how_to_precompile.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
# For Windows
docker run --rm --volume %cd%/paper:/data --env JOURNAL=joss openjournals/inara
Image Name: openjournals/inara
Volume path: Needs to be adjusted between windows and linux
Volume path: Needs to be adjusted between windows and linux


# For Linux
docker run --rm \
--volume $PWD/paper:/data \
--user $(id -u):$(id -g) \
--env JOURNAL=joss \
openjournals/inara
8 changes: 8 additions & 0 deletions paper/paper.jats
Original file line number Diff line number Diff line change
Expand Up @@ -367,6 +367,14 @@ a Creative Commons Attribution 4.0 International License (CC BY
flexibility for some appliances. The source code and appliance load
profiles used have also not been published.</p>
</sec>
<sec id="authors-contribution">
<title>Authors Contribution</title>
<p><bold>Julian Belina</bold>: Software, Writing, Visualization,
Methodology.<bold>Noah Pflugradt</bold>: Conceptualization,
Methodology, Supervision, Writing - Review &amp; Editing.<bold>Detlef
Stolten</bold>: Conceptualization, Phd Supervision, Resources, Funding
acquisition.</p>
</sec>
</body>
<back>
<ref-list>
Expand Down
2 changes: 1 addition & 1 deletion paper/paper.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,6 @@ The software eLOAD employs an approach similar to that from Sandhaas. Instead of

# Authors Contribution

**Julian Belina**:Software, Writing, Visualization, Methodology.**Noah Pflugradt**:Conceptualization, Methodology, Supervision, Writing - Review & Editing.**Detlef Stolten**:Conceptualization, Phd Supervision, Resources, Funding acquisition.
**Julian Belina**: Software, Writing, Visualization, Methodology.**Noah Pflugradt**: Conceptualization, Methodology, Supervision, Writing - Review & Editing.**Detlef Stolten**: Conceptualization, Phd Supervision, Resources, Funding acquisition.

# References
Binary file modified paper/paper.pdf
Binary file not shown.

0 comments on commit b45362d

Please sign in to comment.