caltechauthors
The CaltechAUTHORS InvenioRDM source code
Science Score: 57.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 2 DOI reference(s) in README -
✓Academic publication links
Links to: zenodo.org -
○Academic email domains
-
✓Institutional organization owner
Organization caltechlibrary has institutional domain (www.library.caltech.edu) -
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (13.7%) to scientific vocabulary
Keywords
Repository
The CaltechAUTHORS InvenioRDM source code
Basic Info
- Host: GitHub
- Owner: caltechlibrary
- License: other
- Language: HTML
- Default Branch: main
- Homepage: https://authors.library.caltech.edu
- Size: 5.1 MB
Statistics
- Stars: 6
- Watchers: 4
- Forks: 1
- Open Issues: 72
- Releases: 1
Topics
Metadata Files
README.md
CaltechAUTHORS
This is the source repsository for CaltechAUTHORS, Caltech's Institutional Publications Repository. It is an instance of the InvenioRDM repository platform.
Table of contents
- Introduction
- Installation
- Usage
- Known issues and limitations
- Getting help
- Contributing
- License
- Authors and history
- Acknowledgments
Introduction
This repository was initialized following the InvenioRDM instructions/. It was then customized to meet the needs of the Caltech community. This is only one deployment example, and may or not be appropriate for your specific institution and IT setup.
Installation
We currently deploy CaltechAUTHORS on a m6i.xlarge AWS EC2 instance with Ubuntu 22.04. We use this cloud-init file to do most of the initial setup.
Install NVM
We haven't gotten NVM to install with cloud-init. Run curl -o-
https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash, then
reboot and type nvm install 16
Install InvenioRDM
We use a local copy of idutils with custom identifiers
git clone https://github.com/caltechlibrary/idutils.git
cd idutils
git checkout authors
cd ../caltechauthors
pipenv install
invenio-cli packages install ../idutils
invenio-cli services setup --no-demo-data
You'll also need to install the new-authors branch of https://github.com/caltechlibrary/invenio-rdm-records and authors branches of https://github.com/caltechlibrary/invenio-communities.git and https://github.com/caltechlibrary/invenio-app-rdm You'll need a .env file in /Sites, which includes secrets:
INVENIO_DATACITE_PASSWORD=
INVENIO_SECRET_KEY=
INVENIO_S3_ACCESS_KEY_ID=
INVENIO_S3_SECRET_ACCESS_KEY=
INVENIO_LOGGING_CONSOLE_LEVEL=
INVENIO_MAIL_PASSWORD=
Edit /etc/sysctl.conf and add vm.maxmapcount=262144
This configuration uses S3 for storage. You need to change the bucket name with
pipenv run invenio files location s3-default s3://caltechauthors --default
Add access to the admin panel pipenv run invenio access allow administration-access role admin
Get the latest ROR data from https://doi.org/10.5281/zenodo.6347574 and import the funders vocabulary with
wget https://zenodo.org/record/7038913/files/v1.5-2022-08-31-ror-data.zip?download=1 -O ror.zip
pipenv run invenio vocabularies import --vocabulary funders --origin "/Sites/caltechdata/ror.zip"
We have a local awards list, generated by https://github.com/caltechlibrary/irdmtools awards2vocabulary.py. Load into RDM with
pipenv run invenio vocabularies import --vocabulary awards --filepath ./vocabularies-future.yaml
We have a local CaltechPEOPLE list, which is loaded with
pipenv run invenio vocabularies import --vocabulary names --filepath ./vocabularies-future.yaml
Domain Configuration
You'll need a domain name, and set an A record to point the domain name to your AWS instance.
Move nginx.conf to /etc/nginx/sites-enabled/default
Copy redirect-map.conf to /etc/nginx/
Get a certificate with sudo certbot --nginx
Restart nginx with sudo service nginx restart
Systemctl
We need three services to run InvenioRDM. Set them up with
sudo cp rdm_rest.service /etc/systemd/system/.
sudo cp rdm.service /etc/systemd/system/.
sudo cp rdm_celery.service /etc/systemd/system/.
sudo systemctl daemon-reload
sudo systemctl start rdm
sudo systemctl start rdm_rest
sudo systemctl start rdm_celery
You should now have a InvenioRDM repository fully running!
Usage
Stopping InvenioRDM
cd /Sites/caltechdata
sudo systemctl stop nginx
sudo systemctl stop rdm
sudo systemctl stop rdm_rest
sudo systemctl stop rdm_celery
invenio-cli services stop
Starting InvenioRDM
``` cd /Sites/caltechdata invenio-cli services start
Make sure there are no errors in the invenio-saml install
sudo systemctl start rdmcelery sudo systemctl start rdmrest sudo systemctl start rdm sudo systemctl start nginx ```
Known issues and limitations
These insttallation instructions are intended for this specific Caltech deployment, and you may need to modify them to work for your specific configuration.
Getting help
Please open an issue or pull request if you notice any problems or have questions.
Contributing
Please see our Contributing guidelines
License
Software produced by the Caltech Library is Copyright © 2024 California Institute of Technology. This software is freely distributed under a BSD/MIT type license. Please see the LICENSE file for more information.
Authors and history
Tom Morrell led the CaltechDATA InvenioRDM development. Tommy Keswick helped with themeing and site design. TUGraz and all the other InvenioRDM partners were instrumental in getting all the customizations working.
Acknowledgments
This work was funded by the California Institute of Technology Library.
Owner
- Name: Caltech Library
- Login: caltechlibrary
- Kind: organization
- Email: helpdesk@library.caltech.edu
- Location: Pasadena, CA 91125
- Website: https://www.library.caltech.edu/
- Repositories: 84
- Profile: https://github.com/caltechlibrary
We manage the physical and digital holdings of the California Institute of Technology, provide services and training, and develop open-source software.
CodeMeta (codemeta.json)
{
"@context": "https://doi.org/10.5063/schema/codemeta-2.0",
"@type": "SoftwareSourceCode",
"author": [
{
"@id": "https://orcid.org/0000-0001-9266-5146",
"@type": "Person",
"affiliation": {
"@type": "Organization",
"name": "Caltech Library"
},
"familyName": "Morrell",
"givenName": "Thomas E."
},
{
"@id": "https://orcid.org/0000-0001-5644-440X",
"@type": "Person",
"affiliation": {
"@type": "Organization",
"name": "Caltech Library"
},
"familyName": "Keswick",
"givenName": "Tommy"
},
{
"@id": "https://orcid.org/0000-0003-0900-6903",
"@type": "Person",
"affiliation": {
"@type": "Organization",
"name": "Caltech Library"
},
"familyName": "Doiel",
"givenName": "Robert"
},
{
"@id": "https://orcid.org/0000-0001-9105-5960",
"@type": "Person",
"affiliation": {
"@type": "Organization",
"name": "Caltech Library"
},
"familyName": "Hucka",
"givenName": "Michael"
}
],
"issueTracker": "https://github.com/caltechlibrary/caltechdata/issues",
"license": "https://github.com/caltechlibrary/caltechdata/blob/main/LICENSE",
"developmentStatus": "active",
"downloadUrl": "https://github.com/caltechlibrary/caltechdata/archive/main.zip",
"codeRepository": "https://github.com/caltechlibrary/caltechdata",
"datePublished": "2022-09-21",
"keywords": [
"InvenioRDM",
"Institutional",
"Repository"
],
"name": "CaltechDATA Repository",
"description": "InvenioRDM source for CaltechDATA Repository",
"version": "1.0.2",
"maintainer": "https://orcid.org/0000-0001-9266-5146",
"funder": [
{
"@id": "https://doi.org/10.13039/100006961",
"@type": "Organization",
"name": "Caltech Library"
}
]
}
GitHub Events
Total
- Issues event: 26
- Watch event: 2
- Issue comment event: 20
- Push event: 26
- Pull request event: 2
- Create event: 1
Last Year
- Issues event: 26
- Watch event: 2
- Issue comment event: 20
- Push event: 26
- Pull request event: 2
- Create event: 1
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 139
- Total pull requests: 1
- Average time to close issues: 3 months
- Average time to close pull requests: less than a minute
- Total issue authors: 2
- Total pull request authors: 1
- Average comments per issue: 0.38
- Average comments per pull request: 1.0
- Merged pull requests: 1
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 22
- Pull requests: 1
- Average time to close issues: about 1 month
- Average time to close pull requests: less than a minute
- Issue authors: 1
- Pull request authors: 1
- Average comments per issue: 0.36
- Average comments per pull request: 1.0
- Merged pull requests: 1
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- tmorrell (123)
- rsdoiel (4)
Pull Request Authors
- tmorrell (1)