https://github.com/nfstream/nfstream.github.io
nfstream.org website
https://github.com/nfstream/nfstream.github.io
Last synced: 11 months ago
JSON representation
nfstream.org website
- Host: GitHub
- URL: https://github.com/nfstream/nfstream.github.io
- Owner: nfstream
- Created: 2020-01-08T12:53:43.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-05-10T16:33:45.000Z (about 2 years ago)
- Last Synced: 2025-06-12T22:32:28.374Z (about 1 year ago)
- Language: HTML
- Homepage:
- Size: 1.16 MB
- Stars: 2
- Watchers: 2
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# nfstream.org
[nfstream](https://nfstream.org) is a Python package providing fast, flexible, and expressive data structures
designed to make working with **online** or **offline** network data both easy and intuitive. It aims to be the
fundamental high-level building block for doing practical, **real world** network data analysis in Python.
Additionally, it has the broader goal of becoming **a common network data processing framework for researchers**
providing data reproducibility across experiments.
This repo contains the content for [NFStream web-site](https://nfstream.org).
The project itself can be found here:
## Getting Started
### Prerequisites
1. Git
2. [Jekyll](https://jekyllrb.com/docs/installation/)
### Running locally
1. Clone this repo: `git clone https://github.com/nfstream/nfstream.github.io.git`
2. Run the web-site using Bundler: `bundle exec jekyll serve`
3. Browse to `http://localhost:4000`
## Overview
This web-site is built using [Jekyll](https://jekyllrb.com/) and uses [Just The Docs](https://pmarsceill.github.io/just-the-docs/)
theme for most of its content.
Most of the content is organized in Markdown (.md) files which are easy to generate and maintain.
The only exceptions is the landing Page (`index.html`).
## Contribute
You are more than welcome to contribute to this web-site.
You can do that by either opening [issues on GitHub](https://github.com/nfstream/nfstream.github.io/issues) or by adding/modifying content and create a PR.
If you decide to create a PR please make sure you:
- Test the changes on different browsers
- Test the changes on both desktop and mobile. You don't really have to run it on a mobile device,
each desktop browser offers a mobile view of the page