This is a Python package that can calculate FAIR, CARE and other scores for datasets, based on DCAT-style metadata.
Individual FAIR, CARE & LC Labels assessments are performed in the fair.py and similar files within the calculators folder and the calculators module as a whole imports them all and can be used to run any of them.
The Python dependencies for this package are given in the file pyproject.toml in this folder which is expected to be used with Python’s Poetry tool for environment establishment.
The logic used to generate scored or requirement for labels is given within comments in the script files. The logic is based on IDN deliberations or precedent, in the case of FAIR scores, and may be published in a more human-readable form when a complete first version of the scripts is working.
These Python scripts calculate their various scores from input metadata. In addition to looking for metadata elements, they also look up additional details for values they see online, in particular they attempt to ascertain the indigeneity of Agents associate with a Dataset by looking up the Agent online, in the IDN Agent Catalogue which contains indigeneity notes.
To use the scripts via calc.py, you need to run them as a Python command line program:
~$ python calc.py …
You need to indicate the calculation being performed - "fair", "care" or "lc" and to indicate the source of the metadata to be assessed - a file or online location. You can optionally tell the script how to return results, rather than just printing them to screen. the formal command line arguments are:
The developers of this software - the Indigenous Data Network - recognise that it will be of value beyond their scope, i.e. for non-indigenous, non-Australia data, and are very happy to collaborate with anyone to improve the code. Improvements for others will surely improve the IDN’s own assessments of indigenous Australian data after all.
To collaborate, please formulate Pull Requests against this codebase which the IDN team will review. If you are uncertain about the scpe/direction etc. of a potential PR, please just be in touch and ask up! You could raise an Issue in this codebase’s Issue Tracker to test the waters…
The creators and maintainers of this software wish for it to be available for use as widely as possible. The software is thus licensed using the very permissive BSD 3-Clause software license, a copy of the deed of which is in the file LICENSE.
This software is copyright as follows:
(c) Indigenous Data Network, 2023
For technical enquiries:
Jamie Feiss
Data Infrastructure Developer
Indigenous Data Network
University of Melbourne
jamie.feiss@unimelb.edu.au
For policy:
Levi Murray
Strategic Data Manager
Indigenous Data Network
University of Melbourne
levi.murray@unimelb.edu.au
Owner Organisation
Indigenous Data Network
https://idnau.org