Skip to content

Commit

Permalink
refactor structure and README
Browse files Browse the repository at this point in the history
  • Loading branch information
msramalho committed Jan 11, 2024
1 parent b70b989 commit d949782
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 6 deletions.
25 changes: 19 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,19 @@
# open-source-research-notebooks
Jupyter notebooks helping open source researchers, journalists, and fact-checkers use command line tools and code projects for digital investigations.
# Notebook Links
- holehe - [Link](bellingcat_holehe.ipynb)
- maigret - [Link](bellingcat_maigret.ipynb)
- deepface - [Link](bellingcat_deepface.ipynb)
# Open Source Research Notebooks
A collection of Jupyter Notebooks that demo and can be used during investigations to run command line tools, scripts, and methods. We aim to help open source researchers, journalists, and fact-checkers use command line tools and code projects for digital investigations.

### Why Notebooks?
Jupyter Notebooks
- make it easier to install and run software (less "this does not work on my machine" errors)
- make it safer to run unknown code, when you run it on a Notebook service like [Google Colaboratory](https://colab.google/) or [Binder](https://mybinder.org/)
- make it simpler to document specific code uses: they combine styled documentation with code
- are quick to make and easy to use after you understand how to click through the code cells and edit any custom input
- can run bash commands (command line) as well as code (Python and more)

# Available Notebooks

| **Notebook** | **Description** | **Notebook links** | **Tags** |
| ------------ | ------------------------------------------------- | ------------------------------------------- | ---------------------------------------- |
| Holehe | A tool to find accounts associated with an email | [![Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/bellingcat/open-source-research-notebooks/blob/main/notebooks/community/holehe.ipynb) [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/bellingcat/open-source-research-notebooks/main?labpath=notebooks%2Fcommunity%2Fholehe.ipynb) [![Jupyter Notebook](https://img.shields.io/badge/jupyter-.ipynb%20file-orange)](notebooks/community/holehe.ipynb) | `community`, `digital-footprint-tracing` |
| Maigret | A tool to find accounts associated with a username | [![Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/bellingcat/open-source-research-notebooks/blob/main/notebooks/community/maigret.ipynb) [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/bellingcat/open-source-research-notebooks/main?labpath=notebooks%2Fcommunity%2Fmaigret.ipynb) [![Jupyter Notebook](https://img.shields.io/badge/jupyter-.ipynb%20file-orange)](notebooks/community/maigret.ipynb) | `community`, `digital-footprint-tracing` |
| Deepface | A tool to do facial comparison and analysis | [![Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/bellingcat/open-source-research-notebooks/blob/main/notebooks/community/deepface.ipynb) [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/bellingcat/open-source-research-notebooks/main?labpath=notebooks%2Fcommunity%2Fdeepface.ipynb) [![Jupyter Notebook](https://img.shields.io/badge/jupyter-.ipynb%20file-orange)](notebooks/community/deepface.ipynb) | `community`, `ai`, `image analysis` |

File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit d949782

Please sign in to comment.