empiric
Empiric!, an easy-to-use framework to conduct empirical experiments, with a particular focus on geospatial data perception and contribution
Science Score: 13.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
○.zenodo.json file
-
○DOI references
-
○Academic publication links
-
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (15.8%) to scientific vocabulary
Repository
Empiric!, an easy-to-use framework to conduct empirical experiments, with a particular focus on geospatial data perception and contribution
Basic Info
- Host: GitHub
- Owner: mocnik-science
- License: gpl-3.0
- Language: Python
- Default Branch: main
- Size: 324 KB
Statistics
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
- Releases: 0
Metadata Files
README.md
Empiric!
The Python package Empiric! provides an easy-to-use framework to conduct empirical experiments, with a particular focus on geospatial data perception and contribution.
When running an experiment in Empiric!, a web server is started. Interviewees visit the website offered by the server to participate in interactive experiments and answer questions. The way these experiments, questionnaires, and other pages are shown is defined in a manuscript, which makes, among others, possible to divide the group of interviewees into several comparison groups and to dynamically react to the results provided by the interviewees. A log is created for each of the interviewees and the results of the experiments and questionnaires are stored in JSON files, which can be used by any application you want. In addition, Empiric! offers a statistical analysis of the results, which includes visualiatzions offered on a website.
Installation
To install Empiric!, you will need python3 and pip (How to install pip). Then execute:
bash
pip install Empiric
On some operating systems, pip for python3 is named pip3:
bash
pip3 install Empiric
Further, you need the JavaScript package manager Yarn to run Empiric!. It will be used to automatically download the JavaScript libraries needed for the web interface. If you have Node.js with npm installed, you can install Yarn as follows:
bash
npm install -g yarn
Please find further information about how to install Yarn on https://yarnpkg.com.
Minimal Example
To get Empiric! running and serve your first simple questionnaire, create a python file in which you define a manuscript for the interviews first:
```python
from Empiric import Experiment, pageQuestionnaire
def manuscript(m):
pageQuestionnaire(m, questions='''
In order to run the experiment, you execute the following after defining the manuscript:
python
experiment = Experiment()
experiment.run(manuscript)
Congratulations! You have prepared your first experiment. When running the code, the website will be served for local use only. It will automatically be opened in your default browser. The first interviewee can start with the interview. Further modes are available to run the website even in a non local mode, allowing interviewees to participate over internet. For further information, see Section Experiment.
Usage
The following modules are available (please click on their names to access further documentation):
- Manuscripts - Manuscripts describe which pages are shown to the interviewee and in which order
- Experiments - Experiments are the heart of
Empiric! - Page ‘First’ - A page asking for consent
- Page ‘Info’ - A page showing only general information; often used as a welcome page
- Page ‘Questionnaire’ - A page that shows a questionnaire
- Page ‘Map’ - A page that allows for interaction with elements on a map
- Page ‘Demography’ - A page collecting for demographic information
- Page ‘FinalComments’ - A page collecting final comments
- Page ‘Final’ - A page saying ‘Thank You’
- Redirect - A redirect to another website
- Creating new pages - How to create and use a new page
- Collected data – The data format of the data stored
- Statistics – How to access the results of the experiment and analyse them
Author
This software is written and maintained by Franz-Benjamin Mocnik, mail@mocnik-science.net.
(c) by Franz-Benjamin Mocnik, 2020–2022.
License
The code is licensed under the GPL-3.
Owner
- Name: Franz-Benjamin Mocnik
- Login: mocnik-science
- Kind: user
- Location: Salzburg, Austria
- Company: Paris Lodron University of Salzburg
- Website: www.mocnik-science.net
- Repositories: 19
- Profile: https://github.com/mocnik-science
GitHub Events
Total
Last Year
Committers
Last synced: over 2 years ago
Top Committers
| Name | Commits | |
|---|---|---|
| Franz-Benjamin Mocnik | m****l@f****t | 165 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 12 months ago
All Time
- Total issues: 0
- Total pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Total issue authors: 0
- Total pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 0
- Pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 5 last-month
- Total dependent packages: 0
- Total dependent repositories: 1
- Total versions: 2
- Total maintainers: 1
pypi.org: empiric
Empiric!, an easy-to-use framework to conduct empirical experiments, with a particular focus on geospatial data perception and contribution
- Homepage: https://github.com/mocnik-science/empiric
- Documentation: https://empiric.readthedocs.io/
- License: GPL-3
-
Latest release: 0.0.2
published about 6 years ago
Rankings
Maintainers (1)
Dependencies
- @fortawesome/fontawesome-free ^5.15.4
- dayjs ^1.8.26
- jQuery-ui-Slider-Pips https://github.com/simeydotme/jQuery-ui-Slider-Pips/
- jquery ^3.4.1
- jqueryui ^1.11.1
- leaflet ^1.6.0
- leaflet-draw ^1.0.4
- leaflet-path-transform ^1.1.3
- vega ^5.11.1
- vega-embed ^6.8.0
- vega-lite ^4.12.0
- 244 dependencies
- flask *
- flask_login *
- jsonpath-ng *