/pycoa-book

PyCoa Jupyter Book

Primary LanguageJupyter NotebookMIT LicenseMIT

PyCoa - A Python Covid Analysis toolkit

PyCoA (Python Covid Analysis) is a Python™ code framework which provides:

  • a simple access to the main databases of Covid19;
  • tools to display and analyse data related to Covid19, such as time series or maps.

Technologies used

Prerequisites

No prior knowledge is required.

Repository contents

This repository contains the following directories and files:

  • README.md: This file you are currently reading.
  • _toc.yml: This file defines the structure of the book and the table of contents.
  • docs/: This folder contains the notebooks and MarDown files that make up the content of this book, organised by topic.
  • images/: This folder may contain images and other multimedia files used in the notebooks.

Note: The directory and file structure may vary slightly depending on the Jupyter Book configuration used.

Instructions for use

To use this book, follow these steps:

  1. Install Jupyter Book: Follow the installation instructions on the Jupyter Book website: https://jupyterbook.org/start/overview.html.
  2. Clone the repository: Open a terminal or command prompt and run the following command to clone this repository:
git clone https://github.com/coa-project/pycoa-book.git
  1. Navigate to the repository directory:
cd pycoa-book
  1. Build the book: Run the following command to build the Jupyter Book:
jupyter book build ./
  1. View the book: The book will be generated in HTML format in the _build/html directory. You can open the index.html file in your web browser to view the course content.

Contributions

If you would like to contribute to this repository, you can submit pull requests on GitHub. We welcome any corrections, improvements or suggestions you can contribute to the course.

License

This repository is distributed under the [MIT License]. See the LICENSE file for details.

Contact

For any questions related to the course or the repository, please contact support@pycoa.fr or create an Issue on GitHub