README.md 1.39 KB
Newer Older
1
## SemanticLayerTools
malte.vogl's avatar
malte.vogl committed
2

3
4
Collects tools to create semantic layers in the socio-epistemic networks framework. Source material can be any structured corpus with metadata of authors, time, and at least one text column.

malte.vogl's avatar
malte.vogl committed
5
6
Documentation is available on [ReadTheDocs](https://semanticlayertools.readthedocs.io/).

7
8
## Installation

malte.vogl's avatar
malte.vogl committed
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
tl;dr Use pip

~~~bash
pip install semanticlayertools
~~~

Consider using a clean virtual environment to keep your main packages separated.
Create a new virtual environment and install the package

~~~bash
python3 -m venv env
source env/bin/activate
pip install semanticlayertools
~~~

To use some sentence embedding utility functions please install with the
`embeddml` option

~~~bash
pip install semanticlayertools[embeddml]
~~~
30
31
32

## Testing

malte.vogl's avatar
malte.vogl committed
33
34
35
36
37
38
Tests can be run by installing the _dev_ requirements and running `tox`.

~~~bash
pip install semanticlayertools[dev]
tox
~~~
39
40
41

## Building documentation

malte.vogl's avatar
malte.vogl committed
42
43
44
45
46
47
48
49
50
51
52
53
54
The documentation is build using _sphinx_. Install with the _dev_ option and run

~~~bash
pip install semanticlayertools[dev]
tox -e docs
~~~

## Funding information

The development is part of the research project [ModelSEN](https://modelsen.mpiwg-berlin.mpg.de)

> Socio-epistemic networks: Modelling Historical Knowledge Processes,

55
in Department I of the Max Planck Institute for the History of Science
malte.vogl's avatar
malte.vogl committed
56
and funded by the Federal Ministry of Education and Research, Germany (Grant No. 01 UG2131).