semvec/pypi-packages huggingface dataset:
negoce-ct-datamanagement 0.0.12
Package to handle Negoce CT data
Requires Python: >=3.12

# Installation local
* Activer le venv souhaité (cf. [config] Création venv)
* Mise à jour pip [facultatif] 
```
python -m pip install --upgrade pip
```
* Installation des dépendences
```
pip install -r requirements.txt
```


# Gestion en tant que package python
## Build du package
* Depuis le venv, installation du builder
```
python -m pip install --upgrade build
```
* Lancer le build
```
python -m build
```
*Le résultat du build sera généré dans le dossier dist*

## Install du package
### Mode développement
Depuis le venv souhaité, lancer la commande depuis la racine du projet
```
pip install -e .
```
*L'avantage est qu'il est possible de modififier / mettre des points d'arrets*
### Mode dépendance classique
Depuis le venv souhaité, lancer la commande au niveau du tar.gz généré par le build
```
pip install .
```


# [config] Fichier d'environnements
Penser à déposer manuellement les fichiers .env sur le serveur car ils ne sont pas stockées dans GitHub pour des raisons de sécurites

# [config] Création venv 
Installation d'un environnement virtuel (python 3.12.5 pour être iso serveur; prérequis avoir 3.12.5 en local)
```
py -3.12 -m venv .venv
```
Sur serveur Debian 11
```
python3.12 -m venv .venv
```

# [config] Download des dépendances en local
*La commande pip install directement sur le serveur ne fonctionne pas.* 
*Le contournement est de télécharger en local les librairies, de les déposer sur le serveur puis de les installer*
* Créer un venv avec une version python similaire à celle du serveur cible (cf. [config] Création venv)
* Lancer la commande depuis le dossier .libs
```
pip download --platform manylinux_2_28_x86_64 --only-binary=:all: -r ../requirements.txt
```
* Ajouter dans le dossier .libs le build (fichier .whl) des librairies in-house (tel que negoce-ct-datamanagement)
* Ajouter le dernier pip [facultatif]
```
pip download --platform manylinux_2_28_x86_64 --only-binary=:all: pip
```

# [config] Install des dépendances sur le serveur
*prérequis: [config] Download des dépendances en local*
* Activer le venv sur le serveur cible, dans le dossier .venv/bin
```
source activate
```
* Mise à jour de pip [facultatif], depuis le dossier .libs
```
pip install --no-index --find-links . --upgrade pip
```
* Installation des dépendances, depuis le dossier .libs
```
pip install --no-index --find-links . -r ../requirements.txt
```
* Penser à installer les dépendences in-house
```
pip install --no-index --find-links . negoce_ct_datamanagement==0.0.2
```
nomad-parser-plugins-database 1.1.3
Collection of NOMAD parsers for databases.

This is a collection of the NOMAD parsers for the following databases.

1. [openKIM](https://openkim.org/)

Each of the parsers will read the relevant input and output files and provide all information in
NOMAD's unified Metainfo based Archive format.

## Preparing code input and output file for uploading to NOMAD

NOMAD accepts `.zip` and `.tar.gz` archives as uploads. Each upload can contain arbitrary
files and directories. NOMAD will automatically try to choose the right parser for you files.
For each parser (i.e. for each supported code) there is one type of file that the respective
parser can recognize. We call these files `mainfiles` as they typically are the main
output file a code. For each `mainfile` that NOMAD discovers it will create an entry
in the database that users can search, view, and download. NOMAD will associate all files
in the same directory as files that also belong to that entry. Parsers
might also read information from these auxillary files. This way you can add more files
to an entry, even if the respective parser/code might not directly support it.

To create an upload with all calculations in a directory structure:

```
zip -r <upload-file>.zip <directory>/*
```

Go to the [NOMAD upload page](https://nomad-lab.eu/prod/rae/gui/uploads) to upload files
or find instructions about how to upload files from the command line.

## Using the parser

You can use NOMAD's parsers and normalizers locally on your computer. You need to install
NOMAD's pypi package:

```
pip install nomad-lab
```

To parse code input/output from the command line, you can use NOMAD's command line
interface (CLI) and print the processing results output to stdout:

```
nomad parse --show-archive <path-to-file>
```

To parse a file in Python, you can program something like this:
```python
import sys
from nomad.cli.parse import parse, normalize_all

# match and run the parser
archive = parse(sys.argv[1])
# run all normalizers
normalize_all(archive)

# get the 'main section' section_run as a metainfo object
section_run = archive.section_run[0]

# get the same data as JSON serializable Python dict
python_dict = section_run.m_to_dict()
```

## Developing the parser

Create a virtual environment to install the parser in development mode:

```
pip install virtualenv
virtualenv -p `which python3` .pyenv
source .pyenv/bin/activate
```

Install NOMAD's pypi package:

```
pip install nomad-lab
```

Clone the atomistic parsers project and install it in development mode:

```
git clone https://github.com/nomad-coe/atomistic-parsers.git atomistic-parsers
pip install -e atomistic-parsers
```