Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
tmorrell authored Feb 8, 2024
1 parent 601f383 commit d90d935
Showing 1 changed file with 30 additions and 17 deletions.
47 changes: 30 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# CaltechDATA
# CaltechAUTHORS

This is the source repsository for CaltechDATA, Caltech's Institutional Data
and Software Repository. It is an instance of the [InvenioRDM repository
This is the source repsository for CaltechAUTHORS, Caltech's Institutional Publications Repository. It is an instance of the [InvenioRDM repository
platform](https://inveniosoftware.org/products/rdm/).

[![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg?color=orange)](https://choosealicense.com/licenses/bsd-3-clause)
Expand Down Expand Up @@ -32,48 +31,64 @@ institution and IT setup.

## Installation

We currently deploy CaltechDATA on a m6i.xlarge AWS EC2 instance with Ubuntu
20.04. We use this [cloud-init
file](https://github.com/caltechlibrary/cloud-init-examples/blob/main/caltechdata-init.yaml)
We currently deploy CaltechAUTHORS on a m6i.xlarge AWS EC2 instance with Ubuntu
22.04. We use this [cloud-init
file](https://github.com/caltechlibrary/cloud-init-examples/blob/main/invenio-rdm-12-init.yaml)
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 14`
reboot and type `nvm install 16`

### Install InvenioRDM

Clone this repository into /Sites, then go to that directory
We use a local copy of idutils with custom identifiers

```
invenio-cli install
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 need a rdm.conf file in /Sites, which includes secrets:
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=
FLASK_ENV=
INVENIO_LOGGING_CONSOLE_LEVEL=
INVENIO_MAIL_PASSWORD=
```

Edit /etc/sysctl.conf and add vm.max_map_count=262144

This configuration uses S3 for storage. You need to change the bucket name with

`pipenv run invenio files location s3-default s3://caltechdata --default`
`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`

You can load the funders vocabulary with
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
```
Expand Down Expand Up @@ -152,14 +167,12 @@ guidelines](https://github.com/caltechlibrary/caltechdata/blob/main/CONTRIBUTING
## License
Software produced by the Caltech Library is Copyright © 2022 California Institute of Technology. This software is freely distributed under a BSD/MIT type license. Please see the [LICENSE](LICENSE) file for more information.
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](LICENSE) file for more information.
## Authors and history
Tom Morrell led the CaltechDATA InvenioRDM development. Tommy Keswick did all
the themeing and site design. Robert Doiel implemented the Shibboleth login.
Mike Hucka worked on the GitHub integration. TUGraz and all the other
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.
Expand Down

0 comments on commit d90d935

Please sign in to comment.