SCOAP3

Current live version available at: www.repo.scoap3.org

SCOAP3 is a one-of-its-kind partnership of over three-thousand libraries, key funding agencies and research centers in 43 countries and 3 intergovernmental organizations. Working with leading publishers, SCOAP3 has converted key journals in the field of high-energy physics to open access at no cost for authors. SCOAP3 centrally pays publishers for costs involved in providing their services, publishers, in turn, reduce subscription fees to all their customers, who can redirect these funds to contribute to SCOAP3. Each country contributes in a way commensurate to its scientific output in the field. In addition, existing open access journals are also centrally supported, removing any existing financial barrier for authors.

SCOAP3 journals are open for any scientist to publish without any financial barriers. Copyright stays with authors, and a permissive CC-BY license allows text- and data-mining. SCOAP3 addresses open access mandates at no burden for authors. All articles appear in the SCOAP3 repository for further distribution, as well as being open access on publishers’ websites.

License: MIT

---

Pre requirements

Python

Python 3.11

You can also use pyenv for your python installations. Simply follow the instructions and set the global version to 3.8.

poetry

install poetry https://poetry.eustace.io/docs/

curl -sSL https://install.python-poetry.org | python3 - --version 1.1.14

nodejs & npm using nvm

Please follow the instructions https://github.com/nvm-sh/nvm#installing-and-updating

For running the front-end pipeline, install v18.16.0

nvm install 18.16.0
nvm use global 18.16.0

pre-commit

install pre-commit https://pre-commit.com/

curl https://pre-commit.com/install-local.py | python -

And run

pre-commit install

Docker & Docker Compose

Follow the guide https://docs.docker.com/compose/install/

---

How to run

Local

If you don't want to use the makefile, make sure the .envs/local/ files are loaded.

Start services

make services

or

docker-compose up -d mailhog mq opensearch celerybeat redis db

Make migrations

docker-compose exec django python manage.py makemigrations

or

poetry run python manage.py makemigrations

Apply migrations

docker-compose exec django python manage.py migrate

or

poetry run python manage.py migrate

Start celery worker

make celery

or

poetry run poetry run celery -A config.celery_app worker --loglevel=info

Start django

make django

or

poetry run python manage.py runserver 0.0.0.0:8000

Start webpack

make webpack

or

npm run dev

Start UI

In scoap3/ui:

yarn dev

Docker

Start

docker-compose up

Usage

After startup, the application should be available at localhost:3000

Flush

To flush all tables, run:

docker-compose exec django python manage.py flush

or

poetry run python manage.py flush

Be sure to type yes otherwise the flush won't execute!

Populate

To insert some demo data and create a superuser with the following credentials:

• Username: admin
• Password: admin

make sure the db is flushed otherwise it could cause some duplicate errors and run:

docker-compose exec django python manage.py loaddata local

or

make load-demo-data

---

How to test

Docker

docker-compose run --rm django pytest

Local

For running the tests you only need the django, db, redis and mq service. You can start only the needed services using

docker-compose run django

To run the tests, use:

poetry run pytest

Or start the services and docker using the makefile and run:

make tests

Tools

[TODO]