atap_widgets

This package is part of the atap project.

Features

• Conversation recurrence plotting
• Concordance search and export

Requirements

• Python 3.8+
• spacy
• pandas
• Interactive widgets are designed for use in Jupyter Lab (3+)

Installation

You can install atap_widgets via pip from PyPI:

$ pip install atap_widgets

NOTE: on M1 Macs with the new Apple Silicon chip, you may need a Rust compiler installed. Rust can be installed with a single command via https://rustup.rs/ . You may also need cmake: install via Homebrew with brew install cmake.

Standalone tools

Use the Concordancer as a standalone tool by clicking the following Binder link

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.

If you do not have access to any of the above accounts, you can use the below link to access the tool (this is a free Binder version, limited to 2GB memory only).

Concordancer Tool User Guide

For instructions on how to use the Concordancer tool, please refer to the Concordancer Tool User Guide.

Development

This project uses poetry for dependency management and packaging. Please see the poetry docs for details. Dependencies are specified in pyproject.toml.

This repository is configured to automatically publish new releases to PyPI if you merge a pull request with an updated version number. That means to release a new version with new features/fixes, you should:

• Create a branch
• Perform your work on that branch
• Update the package version, e.g. with poetry version patch or poetry version minor
• Commit the changes to pyproject.toml
• Create a pull request for the branch on GitHub
• Merge the branch into main when you're ready to release

Contributing

Contributions are very welcome. To learn more, see the Contributor Guide.

License

Distributed under the terms of the MIT license, atap_widgets is free and open source software.

Citation

If you find the ATAP Concordancer tool useful in your research, please cite the following:

Bednarek, M., Mather, M., Maras, K., & Croser, H. (2023). ATAP Concordancer (v0.5.4) [Computer software]. https://github.com/Australian-Text-Analytics-Platform/atap_widgets. DOI. https://doi.org/10.5281/zenodo.10086731

Issues

If you encounter any problems, please file an issue along with a detailed description.

Credits

This project was generated from @cjolowicz's Hypermodern Python Cookiecutter template.