-
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.
Updated the README of the standard plugin content to include pip install instructions
- Loading branch information
1 parent
adee248
commit 1fdf42c
Showing
1 changed file
with
5 additions
and
25 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,31 +1,17 @@ | ||
# NOMAD's schema example plugin | ||
# NOMAD's metinfo-yaml2py plugin | ||
|
||
## Getting started | ||
|
||
### Fork the project | ||
### Install your python plugin package | ||
|
||
Go to the github project page https://github.com/nomad-coe/nomad-schema-plugin-example, hit | ||
fork (and leave a star, thanks!). Maybe you want to rename the project while forking! | ||
|
||
### Clone your fork | ||
|
||
Follow the github instructions. The URL and directory depends on your user name or organization and the | ||
project name you choose. But, it should look somewhat like this: | ||
|
||
``` | ||
git clone [email protected]:markus1978/my-nomad-schema.git | ||
cd my-nomad-schema | ||
``` | ||
|
||
### Install the dependencies | ||
|
||
You should create a virtual environment. You will need the `nomad-lab` package (and `pytest`). | ||
You should create a virtual environment. | ||
You need at least Python 3.9. | ||
From the top directory of your plugin you can install it en editable mode with: | ||
|
||
```sh | ||
python3 -m venv .pyenv | ||
source .pyenv/bin/activate | ||
pip install -r requirements.txt --index-url https://gitlab.mpcdf.mpg.de/api/v4/projects/2187/packages/pypi/simple | ||
pip install -e . --index-url https://gitlab.mpcdf.mpg.de/api/v4/projects/2187/packages/pypi/simple | ||
``` | ||
|
||
**Note!** | ||
|
@@ -35,12 +21,6 @@ in `requirements.txt`. | |
|
||
### Run the tests | ||
|
||
Make sure the current directory is in your path: | ||
|
||
```sh | ||
export PYTHONPATH=. | ||
``` | ||
|
||
You can run automated tests with `pytest`: | ||
|
||
```sh | ||
|