OpenCitations: Index

This software allows the production of the OpenCitations index

Requirements

Mandatory

• Python 3.7+
• libzip, see INSTALL.md from official repository for additional information.

Optional

• Redis (* mandatory for redis data source), see Installing Redis for additional information.

Install

To install the index software you must first meet all the requirements above. Then the python package must be installed, this adds all the python scripts to the $PATH

$ pip install .

Configuration

By default when index is installed a configuration file is created in ~/.opencitations/index/, namely config.ini. For more information about the semantics of the settings see config.ini.

Usage

See Usage.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

OpenCitations Index is released under the ISC License.