Giter Club home page Giter Club logo

fiber-competition's Introduction

Fibre-competitive-intensity-model-a

Project description

Team Members

  • Gracious Ngetich
  • Tebogo Mngoma
  • Yusuf Kebande
  • Kabelo Tladi
  • John Chukwuebuka

Environment

It's highly recommended to use a virtual environment for your project, there are many ways to do this, below we have provided one example of how this can be achieved. Ensure when working on your project to keep this section up-to-date so if anyone needs to run your code they know the exact steps needed to get the appropriate environment ready. A person should be able to clone your repo and get up and running with the instructions provided here.

Setup - you only need to do this once

# make sure your pip in your base Python installation is up-to-date
python3 -m pip install -U pip
# install the virtualenv package
python3 -m pip install virtualenv

Create the virtual environment - also typically only run when needed

# create a virtual environment in this directory called '.venv'
python3 -m venv .venv
# you should now see the folder `.venv` in your repo

This is how you activate the virtual environment in a terminal and install the project dependencies

# activate the virtual environment
source .venv/bin/activate
# install the requirements for this project
pip install -r requirements.txt

Tests

It's highly recommended to get in the habit of writing tests, especially once you've identified something concrete that you can refactor into a reusable bit of code. This project has been seeded with a minimal working example of a refactored function, a notebook that can import this code and a unit test to test the code behaves as expected.

You can execute tests from the terminal by running pytest. IDEs like VSCode have built-in support for executing and debugging tests through the "Testing" menu.

Project Organisation

├── LICENSE            <- Contains information about the legal terms and conditions under which
|                         the code can be used.
|
├── README.md          <- The top-level README for developers using this project.
│
├── docs               <- Use markdown. If/when the project becomes more complex consider migrating
|                         to something like pdoc or sphinx depending on the nature of the project.
|                         Think carefully about what documentation should sit alongside the code
|                         and what you can rather include in docstrings.
│
├── notebooks          <- Jupyter notebooks. Naming convention is a number (for ordering), and a
│                         short `-` delimited description, e.g. `1.0-initial-data-exploration`.
|                         Refactor the good parts. Don't write code to do the same task in multiple
|                         notebooks. If it's a data preprocessing task, put it in a file like
|                         `src/data/make_dataset.py`. If it's useful utility code, refactor it to
|                         `src` and import accordingly. Only commit clean notebooks (clear all cell outputs).
│
├── requirements.txt   <- The requirements file for reproducing the environment.
|
├── src                <- Source code. Refactor clean, re-usable code here.
│   │
│   ├── data           <- Separate your code base into logical groups, e.g. data, features, models, visualisation, etc.
│   │   └── make_dataset.py
│   └── ...
|
├── tests              <- Unit tests. Filename should start with "test_".
    └── test_make_dataset.py

fiber-competition's People

Contributors

graciousngetich avatar kingjohn4 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.