ckanext-msl_ckan

This extension contains configurations and templates for the EPOS MSL CKAN portal. The use of this extension is depended on several other extensions as described in the requirements section. Reusable functionality has been placed within the msl_ckan_util extension.

Requirements

This extension has been developed and tested with CKAN version 2.9.*

This extension requires the following other extension to be installed and activated:

CKAN extension	Plugin
ckanext-scheming	scheming_datasets
ckanext-scheming	scheming_groups
ckanext-scheming	scheming_organizations
ckanext-msl_ckan_util	msl_ckan
ckanext-msl_ckan_util	msl_custom_facets
ckanext-msl_ckan_util	msl_repeating_fields

TODO: Add links to extension repos

Installation

TODO: Add any additional install steps to the list below. For example installing any non-Python dependencies or adding any required config settings.

To install ckanext-msl_ckan:

1. Activate your CKAN virtual environment, for example:

   . /usr/lib/ckan/default/bin/activate

2. Clone the source and install it on the virtualenv

        git clone https://git.science.uu.nl/epos-msl/epos-msl.git
        cd ckanext-msl_ckan
        pip install -e .
        pip install -r requirements.txt
   

3. Add msl_ckan to the ckan.plugins setting in your CKAN config file (by default the config file is located at /etc/ckan/default/ckan.ini).

4. Restart CKAN.

SOLR changes

The SOLR schema needs to be updated to use the additional fields that are used by the schemas within msl_ckan. The currently used schema is available at /config/solr/schema.xml.

Within the solrconfig.xml make sure that the <str name="q.op"> setting is set to AND for the select request handler:

  <requestHandler name="/select" class="solr.SearchHandler">
<!-- default values for query parameters can be specified, these
     will be overridden by parameters in the request
  -->
<lst name="defaults">
  <str name="echoParams">explicit</str>
  <int name="rows">10</int>
  <str name="mm">1</str>
  <str name="q.op">AND</str> <----
  ...

Config settings

This extension includes several configuration files that are used by other extension required by this project. To make the correct links to the other extensions/plugins the following lines should be added to the ckan.ini.

Load plugins

ckan.plugins in the ckan.ini should contain the following plugins:

  msl_ckan
  scheming_datasets
  scheming_groups
  scheming_organizations 
  msl_custom_facets
  msl_repeating_fields

Make sure to keep the above order of plugin declaration in the ckan.ini. The order of plugin loading determines the order of execution of hooks and usage of templates.

general settings

the following line should be added to within the [app:main] section:

  search.facets.limit = 10000

plugin specific settings

Keep in mind that all plugin specific settings should be added within the same block of settings as the ckan.plugins section within the clan.ini!

To use the schemas as included within this extension by the scheming plugin the following lines should be added to the ckan.ini file:

  scheming.dataset_schemas = ckanext.msl_ckan:schemas/datasets/data_publication.yml ckanext.msl_ckan:schemas/datasets/labs.json
  scheming.organization_schemas = ckanext.msl_ckan:schemas/organizations/organization.json

To use the included facet configuration:

  mslfacets.dataset_config = ckanext.msl_ckan:config/facets.json

To use the included index fields configuration:

  mslindexfields.field_config = ckanext.msl_ckan:config/msl_index_fields.json

For retrieving keyword information an endpoint for the service must be defined:

  mslvocabularies.endpoint_root = http://epos.test:89/api/vocabularies (Sample url)

Adjusting settings within CKAN

Some texts and settings have to be adjusted by signing in as admin within the portal. The default username and password depend on the installation type. It is recommended to change the default credentials after installation.

Generating an API key

Go to your profile in the top bar and click on manage. Within this form click on the Regenerate API key button to make an API key that can be used for access. This API key will be used in other steps of this guide.

Add organizations

Some organizations have to be added to use the current import process. Currently these have to be added manually. Add organizations with the names: EPOS Multi-scale Laboratories Thematic Core Service and yoda repository.

Import data

Set texts

Go to the Sysadmin settings section which is linked to in the top right menu. Click on the Config tab and set the following values using the form.

Intro Text:

![EPOS](https://www.epos-eu.org/themes/epos/logo.svg)

[Check](https://www.epos-eu.org) the new EPOS ERIC website
***
Click https://epos-no.uib.no/epos-tna/facilities to go to the EPOS TNA-/Infrastructure portal for an overview of labs currently involved within the MSL network.
***
This is the central data catalog of the EPOS Multi-scale laboratories community. Here you can find openly published data coming from a wide range of world-class experimental laboratory infrastructures: from high pressure-temperature rock and fault mechanics and rock physics facilities, to electron microscopy, micro-beam analysis, analogue modelling and paleomagnetic laboratories. More information about the Multi-scale laboratories community is to be found at https://epos-ip.org/tcs/multi-scale-laboratories.

Developer installation

To install ckanext-msl_ckan for development, activate your CKAN virtualenv and do:

git clone https://git.science.uu.nl/epos-msl/epos-msl.git
cd ckanext-msl_ckan
python setup.py develop
pip install -r dev-requirements.txt

Tests

To run the tests, do:

pytest --ckan-ini=test.ini

Releasing a new version of ckanext-msl_ckan

If ckanext-msl_ckan should be available on PyPI you can follow these steps to publish a new version:

1. Update the version number in the setup.py file. See PEP 440 for how to choose version numbers.

2. Make sure you have the latest version of necessary packages:

   pip install --upgrade setuptools wheel twine

3. Create a source and binary distributions of the new version:

   python setup.py sdist bdist_wheel && twine check dist/*
   

   Fix any errors you get.

4. Upload the source distribution to PyPI:

   twine upload dist/*
   

5. Commit any outstanding changes:

   git commit -a
   git push
   

6. Tag the new release of the project on GitHub with the version number from the setup.py file. For example if the version number in setup.py is 0.0.1 then do:

   git tag 0.0.1
   git push --tags
   

License

AGPL