harmonydata/harmonyapi repository overview

⁠Harmony API

🌐 harmonydata.ac.uk⁠

⁠Using the Harmony REST API Docker container

This is a Docker container containing the Harmony⁠ REST API using FastAPI⁠ including Apache Tika⁠. This contains the Harmony Python library⁠ which you can also install from Pypi⁠.

There is a deployed version of the API at https://api.harmonydata.ac.uk/docs⁠.

docker pull harmonydata/harmonyapi
docker run -p 8000:8000 -p 3000:3000 harmonydata/harmonyapi

You can read more about the Harmony REST API on our blog⁠

⁠About the Harmony project

• Psychologists and social scientists often have to match items in different questionnaires, such as "I often feel anxious" and "Feeling nervous, anxious or afraid".
• This is called harmonisation.
• Harmonisation is a time consuming and subjective process.
• Going through long PDFs of questionnaires and putting the questions into Excel is no fun.
• Enter Harmony⁠, a tool that uses natural language processing⁠ and generative AI models to help researchers harmonise questionnaire items, even in different languages⁠.

You can try Harmony at https://app.harmonydata.ac.uk⁠ and you can read our blog at https://harmonydata.ac.uk/blog/⁠.

The source code for Harmony is on Github at https://github.com/harmonydata/harmony⁠ and the source code for the API (this Docker container) is at https://github.com/harmonydata/harmonyapi⁠.

Here's a walkthrough video on how you can use Harmony online at harmonydata.ac.uk. Click to view:

⁠✉️Who to contact about Harmony?

You can contact us at https://harmonydata.ac.uk/contact/⁠.

⁠📜How do I cite Harmony?

McElroy, E., Moltrecht, B., Ploubidis, G.B., Scopel Hoffman, M., Wood, T.A., Harmony [Computer software], Version 1.0, accessed at https://app.harmonydata.ac.uk⁠. Ulster University (2022)

⁠🧑 Who developed the Python code of Harmony?

• Thomas Wood (Fast Data Science⁠)