Here’s a quick start guide to running Harmony, an open source tool for social science research. These instructions are for the complete version of Harmony including the graphical browser-based tool which is available online at https://harmonydata.ac.uk/app/. If you only need the Python or R libraries, or the REST API, please refer to our Github page.
You will need to first download and install a couple of programs that Harmony needs to run.
You need a computer with at least 16 GB RAM – in other words, a fairly high-end computer. This is because Harmony does two things that need some computational heavy lifting:
In addition, the browser-based front end is running in Node.js to make the nice graphics that you can see on our web tool.
If you don’t need all of this functionality, you may prefer to install the Harmony Python library, R library, REST API or even run our Docker container available from our DockerHub page.
Download and install Java, Node.js, and NPM if you don’t have them already.
If you are a Mac user and you use Homebrew, you can run this in the Terminal.
brew install java nodejs npm
If you use Ubuntu, you can run this in the console:
apt-get update
apt-get install default-jre npm nodejs
Please ensure you have Java version 11 or later, NPM version 6.14.4 or later, and Node.js version 10.19.0 or later
Download Apache Tika from this link: https://tika.apache.org/download.html
Then, in the console or Terminal, type:
java -jar tika-server-standard-2.3.0.jar
(the numbers at the end of the file name may change)
Please ensure you have Tika 2.3.0 or later.
If you don’t already have Python on your computer, we recommend to download it from Anaconda. Please ensure you have Python 3.9 or later.
Visit the API Github page and click Code -> Download ZIP. Unzip it on your computer.
In the terminal or console, type
pip install -r requirements.txt
python harmony/src/harmony/util/model_downloader.py
In the terminal or console, type
python main.py
Visit our front end Github page and click Code -> Download ZIP. Unzip it on your computer.
In the Terminal, go inside the folder and type
export REACT_APP_API_URL=http://localhost:8000/
npm install
npm start
Visit your browser at http://localhost:3000 and you should see Harmony running there.
Help us design the next phase of Harmony and win up to £300 in vouchers! Search and Results UX/UI Challenge Harmony is a platform for researchers to help them discover and compare complex meta-data across different academic studies. The project is a collaboration between University College London (UCL), The University of Ulster, and Fast Data Science and has been funded by the Economic and Social Research Council (ESRC) and by Wellcome as part of the Wellcome Data Prize in Mental Health.
It’s all over! The Matching Challenge is now officially closed. Thank you to everyone who took part. The wait is over! We have now closed the Matching Challenge which was hosted on DOXA AI. Over the course of the competition we saw a total of 26 participants with 14 finalists making it onto the scoreboard. The final days were tense with many participants improving on their scores, submitting different methods and swapping places at the top of the scoreboard.