generated from DHI/template-python-library
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
356fbd3
commit f41fa61
Showing
1 changed file
with
3 additions
and
19 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 |
---|---|---|
@@ -1,20 +1,4 @@ | ||
# my_library: Template Python repository | ||
# metocean_units | ||
|
||
This repository serves as a template for creating a Python library | ||
|
||
## How do I use this? | ||
|
||
1. Create a new repository in GitHub with this repo as a starting point | ||
![](images/new_repo.png) | ||
|
||
2. Change all occurences of `my_library` to match the name of your new library | ||
|
||
3. Consider if the [license](LICENSE) should be modified. | ||
|
||
|
||
## Additional resources | ||
|
||
If you're interested in learning more about best practices for developing Python packages, check out the following resources: | ||
|
||
- [Python Package Development at DHI](https://dhi.github.io/python-package-development/) | ||
- [Scientific Python Library Development Guide](https://learn.scientific-python.org/development/) | ||
This repository is a simple library with a units mapping dictionary (long names, short names, units, description) for different workflows. | ||
Goal is to have ca entralized unit database. |