Skip to content

Commit b8e2032

Browse files
pabloitupabloitu
committed
build: instantiated main module folder and __init__.py
build: added tox workflow and text file with requirements for dev installation build: added basic setups and .toml and .yml for conda build brand: added dbcsep logo and svg generator in docs folder (path in consistency with pycsep and floatcsep dir tree). repo: added basic repo files.
1 parent a9b375e commit b8e2032

16 files changed

+674
-83
lines changed

‎.gitignore

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
.idea/
2+
.tox/
3+
__pycache__
4+

‎CODE_OF_CONDUCT.md

+128
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
[email protected].
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series
86+
of actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or
93+
permanent ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within
113+
the community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.0, available at
119+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120+
121+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
122+
enforcement ladder](https://github.com/mozilla/diversity).
123+
124+
[homepage]: https://www.contributor-covenant.org
125+
126+
For answers to common questions about this code of conduct, see the FAQ at
127+
https://www.contributor-covenant.org/faq. Translations are available at
128+
https://www.contributor-covenant.org/translations.

‎CONTRIBUTING.md

+143
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,143 @@
1+
<!-- omit in toc -->
2+
# Contributing to dbcsep
3+
4+
First off, thanks for taking the time to contribute! ❤️
5+
6+
All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉
7+
8+
> And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:
9+
> - Star the project
10+
> - Refer this project in your project's readme
11+
> - Mention the project at local meetups and tell your friends/colleagues
12+
13+
<!-- omit in toc -->
14+
## Table of Contents
15+
16+
- [I Have a Question](#i-have-a-question)
17+
- [I Want To Contribute](#i-want-to-contribute)
18+
- [Reporting Bugs](#reporting-bugs)
19+
- [Suggesting Enhancements](#suggesting-enhancements)
20+
- [Your First Code Contribution](#your-first-code-contribution)
21+
- [Styleguides](#styleguides)
22+
- [Commit Messages](#commit-messages)
23+
- [Join The Project Team](#join-the-project-team)
24+
25+
26+
27+
## I Have a Question
28+
29+
> If you want to ask a question, we hope that you have alredy read the available [Documentation](https://floatcsep.readthedocs.io).
30+
31+
Before you ask a question, it is best to search for existing [Issues](https://github.com/cseptesting/floatcsep/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue.
32+
33+
If you then still feel the need to ask a question and need clarification, we recommend the following:
34+
35+
- Open an [Issue](https://github.com/cseptesting/floatcsep/issues/new).
36+
- Provide as much context as you can about what you're running into.
37+
- Provide project and platform versions (nodejs, npm, etc), depending on what seems relevant.
38+
- Provide the files/artifacts, or simplified versions of them
39+
40+
We will then take care of the issue as soon as possible.
41+
42+
43+
## I Want To Contribute
44+
45+
> ### Legal Notice <!-- omit in toc -->
46+
> When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.
47+
48+
### Reporting Bugs
49+
50+
<!-- omit in toc -->
51+
#### Before Submitting a Bug Report
52+
53+
Please complete the following steps in advance to help us fix any potential bug as fast as possible.
54+
55+
- Make sure that you are using the latest version (or a tag release).
56+
- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [documentation](https://floatcsep.readthedocs.io). If you are looking for support, you might want to check [this section](#i-have-a-question)).
57+
- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://github.com/cseptesting/floatcsepissues?q=label%3Abug).
58+
- Collect information about the bug:
59+
- Stack trace (Traceback)
60+
- OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
61+
- Possibly your input and the expected output
62+
- Can you reliably reproduce the issue?
63+
64+
> You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead, sensitive bugs must be sent by email to <[email protected]>.
65+
66+
<!-- omit in toc -->
67+
68+
69+
### Suggesting Enhancements
70+
71+
This section guides you through submitting an enhancement suggestion for floatcsep, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.
72+
73+
#### Before Submitting an Enhancement
74+
75+
- Make sure that you are using the latest version.
76+
- Read the [documentation](https://floatcsep.readthedocs.io) carefully and find out if the functionality is already covered, maybe by an individual configuration.
77+
- Perform a [search](https://github.com/cseptesting/floatcsep/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
78+
- Use a **clear and descriptive title** for the issue to identify the suggestion.
79+
- **Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point you can also tell which alternatives do not work for you.
80+
- **Explain why this enhancement would be useful** to most floatcsep users. You may also want to point out the other projects that solved it better and which could serve as inspiration.
81+
82+
83+
### Your First Code Contribution
84+
85+
* Make sure you have an active GitHub account
86+
* Fork the repo on GitHub. It will now live at `https://github.com/<YOUR_GITHUB_USERNAME>/dbcsep` ([here is some helping info](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/working-with-forks)).
87+
* Download and install `git`. Check out the git documentaion if you aren't familiar with it.
88+
* Please follow the [Installation](https://floatcsep.readthedocs.io) instructions for developers. Here is a summarized version.
89+
90+
# clone your fork
91+
git clone https://github.com/<YOUR_GITHUB_USERNAME>/dbcsep.git
92+
cd dbcsep
93+
94+
# prepare environment
95+
conda env create -n dbcsep-dev
96+
conda activate dbcsep-dev
97+
pip install -e .[dev]
98+
99+
# add upstream repository
100+
git remote add upstream https://github.com/cseptesting/dbcsep.git
101+
102+
* Note: use the command `conda deactivate` to go back to your regular environment when you are done working with floatCSEP.
103+
104+
You can now do any local changes in your `dbcsep` source code, which you can then `add`, `commit` and `push` to your personal fork.
105+
106+
### Submitting a Pull Request
107+
108+
Pull requests are how we use your changes to the code! Please submit them to us! Here's how:
109+
110+
1. Make a new branch. For features/additions base your new branch at `main`.
111+
2. Make sure to add tests! Only pull requests for documentation, refactoring, or plotting features do not require a test.
112+
3. Also, documentation must accompany new feature requests.
113+
- Note: We would really appreciate pull requests that help us improve documentation.
114+
4. Make sure the tests pass. Run `pytest -v tests/` in the top-level directory of the repo.
115+
5. Push your changes to your fork and submit a pull request. Make sure to set the branch to `dbcsep:main`.
116+
6. Wait for our review. There may be some suggested changes or improvements. Changes can be made after
117+
the pull request has been opening by simply adding more commits to your branch.
118+
119+
Pull requests can be changed after they are opened, so create a pull request as early as possible.
120+
This allows us to provide feedback during development and to answer any questions.
121+
122+
123+
Also, if you find floatCSEP to be useful, but don't want to contribute to the code we highly encourage updates to the documentation!
124+
125+
126+
127+
128+
## Additional Resources
129+
* [Working with Git Forks](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/working-with-forks)
130+
* [Style Guide](http://google.github.io/styleguide/pyguide.html)
131+
* [Docs or it doesn’t exist](https://lukeplant.me.uk/blog/posts/docs-or-it-doesnt-exist/)
132+
* [Quickstart guide for Sphinx](https://www.sphinx-doc.org/en/master/usage/quickstart.html)
133+
* [Pep8 style guide](https://pep8.org/)
134+
* Performance Tips:
135+
* [Python](https://wiki.python.org/moin/PythonSpeed/PerformanceTips)
136+
* [NumPy and ctypes](https://scipy-cookbook.readthedocs.io/)
137+
* [SciPy](https://www.scipy.org/docs.html)
138+
* [NumPy Book](http://csc.ucdavis.edu/~chaos/courses/nlp/Software/NumPyBook.pdf)
139+
140+
141+
142+
## Attribution
143+
This guide is based on the **contributing-gen**. [Make your own](https://github.com/bttger/contributing-gen)!

‎CREDITS.md

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Developers and scientific team:
2+
3+
* Danijel Schorlemmer - Deutsches GeoForschungsZentrum (GFZ), Germany; ETH Zurich, Switzerland - [email protected]
4+
* Pablo Iturrieta - Deutsches GeoForschungsZentrum (GFZ), Germany - [email protected]

0 commit comments

Comments
 (0)