Collection acronyms for identification - cafi#

cafi is a centralized registry for assigning unique identifiers to acronyms, enabling efficient management and cross-software identification of all acronyms consistently.

Key Features#

Efficient organization: Store and manage unique IDs in a single location for easy access and maintenance.
Data license compliance: All data is licensed under Creative Commons Attribution 4.0 International License, ensuring proper attribution and sharing.

Installation - Development#

Prerequisites#

GNU/Linux
Docker (optional)
Docker Compose (optional)
Dev Container CLI (optional)

Steps#

Clone the repository:

git clone https://github.com/LeibnizDSMZ/cafi.git
cd cafi

Docker#

If using Docker, start the development container manually or use VSCode:

devcontainer up --workspace-folder .
devcontainer exec --workspace-folder . bash

Create and activate a virtual environment (inside docker the container):
```
make dev
make runAct
```

Local#

Create and activate a virtual environment:

python -m venv .venv
source .venv/bin/activate

Install the dependencies:

pip install .
pip install -r configs/dev/requirements.dev.txt
pip install -r configs/dev/requirements.test.txt
pip install -r configs/dev/requirements.docs.txt

Contributors#

Isabel Schober
Artur Lissin
Julius Witte
Helko Lüken

License#

All source code is licensed under the MIT License (see LICENSE). The acronym data inside the data folder (src/cafi/data) is licensed under the Creative Commons Attribution 4.0 International License (see LICENSE-CC-BY).