fsetools 0.0.0.dev20200219

Fire Safety Engineering Utility Tools

fseutil

Fire Safety Engineering Tools.

Getting Started

Documentation is under construction.

Installation

Python 3.7 or later is required. Anaconda Distribution is recommended for new starters, it includes Python and few useful packages including a package management tool pip (see below).

pip is a package management system for installing and updating Python packages. pip comes with Python, so you get pip simply by installing Python. On Ubuntu and Fedora Linux, you can simply use your system package manager to install the python3-pip package. The Hitchhiker's Guide to Python provides some guidance on how to install Python on your system if it isn't already; you can also install Python directly from python.org. You might want to upgrade pip before using it to install other programs.

1. to use pip install from PyPI:

   pip install --upgrade fseutil
   

2. to use pip install from GitHub (requires git):

   Note installing fseutil via this route will include the latest commits/changes to the library.

   pip install --upgrade "git+https://github.com/fsepy/fseutil.git@dev"
   

Command line interface

Once fseutil is installed, CLI help can be summoned:

(base) C:\Users\IanFu>fseutil -h

Authors

Ian Fu - [e-mail]

License

This project is licensed under the Apache License version 2.0 - see the LICENSE file for details