Badges

(Customize these badges with your own links, and check https://shields.io/ or https://badgen.net/ to see which other badges are available.)

fair-software.eu recommendations
(1/5) code repository
(2/5) license
<!--	(3/5) community registry		-->
(4/5) citation
(5/5) checklist
howfairis
Other best practices
Static analysis
Coverage
Documentation
GitHub Actions
Build
Citation data consistency
SonarCloud
MarkDown link checker

How to use tempo_embeddings

A library for analysing (temporal) word embeddings.

The project setup is documented in project_setup.md. Feel free to remove this document (and/or the link to this document) if you don't need it.

See the design document for more information on the design of this project.

Installation

To install tempo_embeddings from GitHub repository, do:

git clone git@github.com:Semantics-of-Sustainability/tempo-embeddings.git
cd tempo-embeddings
python3 -m pip install .

How to use tempo_embeddings on SURF Research Cloud?

SURF Research Cloud offers a ready-to-use environment for running tools without the need to install Python and other required libraries.

Here you can apply for access.

If your Research Cloud account is set up for the Semantics of Sustainability project, you can use the tempo-embeddings tool by following these steps:

• Log in to Research cloud environment.
• Create a new workspace using the "semantics-of-sustainability" catalog item.
• Log in to the workspace you created in the previous step.
• Open a new terminal and run:

  /etc/miniconda/bin/conda init

• Close the terminal, open a new one, and run:

  cd /opt/tempo-embeddings/
  conda activate tempo-embeddings

• Start to play with the notebooks using:

  jupyter lab notebooks/[1_compute_embeddings_nl.ipynb]

Documentation

Include a link to your project's full documentation here.

Contributing

If you want to contribute to the development of tempo_embeddings, have a look at the contribution guidelines.

Credits

This package was created with Cookiecutter and the NLeSC/python-template.