Installing BIBCAT

Dependencies

Create a Python Virtual Environment

The recommended way to use BIBCAT is to first create a Python Virtual Environment to install BIBCAT and all of it's module dependencies.

  1. Create a new Python virtual environment

    
    $ python3 -m venv /path/bibcat-env
    

  2. Activate bibcat-env virtual environment

    
    $ source /path/bibcat-env/bin/activate
    (bibcat-env) $
    

Using PIP

With the bibcat-env active, you'll can install BIBCAT from PyPI, the Python Package Index, with the following:


(bibcat-env) $ pip install bibcat

From Source code

  1. Use git to clone a copy of the BIBCAT from Github and then go into the directory.

    
    $ git clone https://github.com/KnowledgeLinks/bibcat.git
    $ cd bibcat
    

  2. OPTION 1 (recommended) - Install BIBCAT with PIP using the -e flag to allow editing of BIBCAT code in your installed Python (system or virtual environment):

    
    (bibcat-env) $ pip install -e .
    

  3. OPTION 2 - Install BIBCAT using setup.py:

    
    $ python3 setup.py install
    

Original contented Copyrighted © 2017 by Jeremy Nelson and KnowledgeLinks under Creative Commons License, Source code repository licensed under the Apache 2 and available on Github.