Skip to content

libratom/ratom-notebooks

Repository files navigation

Logo

ratom-notebooks

Binder

A selection of Jupyter notebooks to demonstrate features of libratom and other utilities developed for the RATOM project.

These example notebooks are under development

Using ratom-notebooks (simple)

The simplest way to interact with these notebooks is via mybinder, which automatically builds an executable environment you can interact with from a web browser. The following link will generate an environment from this repository:

https://mybinder.org/v2/gh/libratom/ratom-notebooks/main

Sample data from the redacted Enron email corpus will be automatically downloaded when this instance is created. You can view the sample files in the RevisedEDRMv1_Complete folder that appears in the Files tab of the Jupyter instance.

In the binder folder, you’ll find the following Jupyter notebooks:

pst_walk.ipynb, a simple example demonstrating walking a PST file using libpff to identify the number of messages present.

message_viewer.ipynb, which examines the contents of a PST file.

entities.ipynb, which identifies all of the entities present in every message body and commits them to a sqlite3 database. Note: this is intended to be run on a local or dedicated hosted instance; running this notebook in mybinder may be slow.

header_fields.ipynb, which shows how to extract and query individual header fields from messages.

After clicking on the mybinder link above, you'll see a loading page; loading may take several minutes. Once the environment has started, you'll be taken to a directory listing where you can click on the desired .ipynb file to view it in a new tab. In the menu within this tab, click on Cell -> Run All to run the entire notebook. Individual code cells are labeled with their purpose and intended output.

Using ratom-notebooks (advanced)

More coming soon...

License(s)

Logos, documentation, and other non-software products of the RATOM team are distributed under the terms of Creative Commons 4.0 Attribution. Software items in RATOM repositories are distributed under the terms of the MIT License. See the LICENSE file for additional details.

© 2022, The University of North Carolina at Chapel Hill.

Development Team and Support

Developed by the RATOM team at the University of North Carolina at Chapel Hill.

See https://ratom.web.unc.edu for additional project details, staff bios, and news.

Releases

No releases published

Packages

No packages published

Languages