discursis

Demo notebooks for ATAP tools

https://github.com/australian-text-analytics-platform/discursis

Science Score: 26.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
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (12.0%) to scientific vocabulary
Last synced: 10 months ago · JSON representation

Repository

Demo notebooks for ATAP tools

Basic Info
  • Host: GitHub
  • Owner: Australian-Text-Analytics-Platform
  • License: mit
  • Language: Jupyter Notebook
  • Default Branch: master
  • Size: 3.07 MB
Statistics
  • Stars: 6
  • Watchers: 3
  • Forks: 1
  • Open Issues: 3
  • Releases: 0
Created over 4 years ago · Last pushed about 1 year ago
Metadata Files
Readme Contributing License Zenodo

README.md

Discursis: conversation analysis and visualisation

This repository contains notebooks to demonstrate Discursis, a conversational analysis and visualisation tool.

If you want to install and use the Discursis tool in your own projects, see the atap_widgets package.

User guide

For a short introduction to the Discursis tool, please see the user guide.

Notebooks

The notebooks demonstrating Discursis are in Jupyter notebooks under notebooks/.

Click the Binder badge to open a demo notebook directly in Binder, an online platform for hosting Jupyter notebooks:

  • Intro to Discursis: Launch on Binder

Note: CILogon authentication is required. You can use your institutional, Google or Microsoft account to login. If you have trouble authenticating, please refer to the CILogon troubleshooting guide.

  • Backup Binder instance: Launch on Binder

Current version: v0.0.1

Run these notebooks

There are a number of different ways to use these notebooks. Binder is quickest and easiest, but it doesn't save your data. I've listed the options below from easiest to most complicated (requiring more technical knowledge).

Using Binder

Launch on Binder

Click on the button above to launch the notebooks in this repository using the Binder service (it might take a little while to load). This is a free service, but note that sessions will close if you stop using the notebooks, and no data will be saved. Make sure you download any changed notebooks or harvested data that you want to save.

See Using Binder for more details.

Using Docker

You can use Docker to run a pre-built computing environment on your own computer. It will set up everything you need to run the notebooks in this repository. This is free, but requires more technical knowledge – you'll have to install Docker on your computer, and be able to use the command line.

  • Install Docker Desktop.
  • Create a new directory for this repository and open it from the command line.
  • From the command line, run the following command:
    docker run -p 8888:8888 --name discursis -v "$PWD":/home/jovyan/work quay.io/ldaca_atap/discursis repo2docker-entrypoint jupyter lab --ip 0.0.0.0 --NotebookApp.token='' --LabApp.default_url='/lab/tree/notebooks/discursis_workshop.ipynb'
  • It will take a while to download and configure the Docker image. Once it's ready you'll see a message saying that Jupyter Notebook is running.
  • Point your web browser to http://127.0.0.1:8888

See Using Docker for more details.

Setting up on your own computer

If you know your way around the command line and are comfortable installing software, you might want to set up your own computer to run these notebooks.

You need to install Git, and the Anaconda Python distribution.

Then the steps to set up an environment with all the required packages are:

  • Clone the repository: git clone https://github.com/Australian-Text-Analytics-Platform/discursis.git
  • Change to the discursis directory: cd discursis
  • Create the environment: conda env create -f environment.yml
  • Activate the environment: conda activate discursis
  • Run Jupyter: jupyter lab

See the GLAM Workbench documentation for more details.

This repository was created using a template from the GLAM Workbench.

Owner

  • Name: Australian-Text-Analytics-Platform
  • Login: Australian-Text-Analytics-Platform
  • Kind: organization

GitHub Events

Total
  • Watch event: 3
  • Delete event: 1
  • Issue comment event: 1
  • Push event: 7
  • Pull request event: 2
  • Create event: 1
Last Year
  • Watch event: 3
  • Delete event: 1
  • Issue comment event: 1
  • Push event: 7
  • Pull request event: 2
  • Create event: 1

Dependencies

.github/workflows/cache_pull_request.yml actions
  • actions/github-script v1 composite
  • jupyterhub/repo2docker-action master composite
.github/workflows/check_notebooks.yml actions
  • actions/checkout v2 composite
  • s-weigand/setup-conda v1 composite
.github/workflows/docker_push.yml actions
  • EndBug/add-and-commit v7.1.0 composite
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
  • jupyterhub/repo2docker-action master composite
binder/Dockerfile docker
  • quay.io/ldaca_atap/discursis 91a11458edc9 build
docker-compose.yml docker
  • quay.io/ldaca_atap/discursis latest
environment.yml pypi
  • atap_widgets ==0.4.0
  • textacy ==0.12.0
pyproject.toml pypi