-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Added Info to README.md * Added Shields to README.md * Changed Installation Instructions in README.md
- Loading branch information
1 parent
dcc99b2
commit 4146c4c
Showing
1 changed file
with
16 additions
and
7 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,17 +1,26 @@ | ||
![](https://github.com/FAIRmat-NFDI/nomad-material-processing/actions/workflows/publish.yml/badge.svg) | ||
![](https://img.shields.io/pypi/pyversions/nomad-material-processing) | ||
![](https://img.shields.io/pypi/l/nomad-material-processing) | ||
![](https://img.shields.io/pypi/v/nomad-material-processing) | ||
|
||
# NOMAD's Material Processing Plugin | ||
This is a plugin for [NOMAD](https://nomad-lab.eu) which contains base sections for | ||
material processing. | ||
|
||
## Getting started | ||
This code is currently under development and can be installed by cloning the repository: | ||
`nomad-material-processing` can be installed from PyPI using `pip`: | ||
```sh | ||
pip install nomad-material-processing | ||
``` | ||
|
||
### Development | ||
This code is currently under development and for installing and contributing you should clone the repository: | ||
```sh | ||
git clone [email protected]:FAIRmat-NFDI/nomad-material-processing.git | ||
cd nomad-material-processing | ||
``` | ||
|
||
And installing the package in editable mode: | ||
And install the package in editable mode: | ||
```sh | ||
pip install -e . --index-url https://gitlab.mpcdf.mpg.de/api/v4/projects/2187/packages/pypi/simple | ||
pip install -e . | ||
``` | ||
|
||
**Note!** | ||
Until we have an official pypi NOMAD release with the plugins functionality. Make | ||
sure to include NOMAD's internal package registry (via `--index-url`). |