https://github.com/opencitations/index
Software for creating all the OpenCitations Indexes (e.g. COCI)
https://github.com/opencitations/index
Last synced: 4 months ago
JSON representation
Software for creating all the OpenCitations Indexes (e.g. COCI)
- Host: GitHub
- URL: https://github.com/opencitations/index
- Owner: opencitations
- License: isc
- Created: 2019-10-09T22:07:52.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2026-01-29T10:57:26.000Z (4 months ago)
- Last Synced: 2026-01-30T00:55:18.357Z (4 months ago)
- Language: Python
- Size: 1.69 MB
- Stars: 15
- Watchers: 4
- Forks: 6
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[
](http://opencitations.net) [](https://github.com/opencitations/index/actions/workflows/python-package.yml)
# OpenCitations: Index
This software allows the production of the OpenCitations index
## Requirements
### Mandatory
- Python 3.7+
- libzip, see [INSTALL.md](https://github.com/nih-at/libzip/blob/master/INSTALL.md) from official repository for additional information.
### Optional
- Redis (* mandatory for redis data source), see [Installing Redis](https://redis.io/docs/getting-started/installation/) 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
```console
$ 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](config.ini).
## Usage
See [Usage](USAGE.md).
## 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](LICENSE).