Metadata-Version: 2.1
Name: coldfront
Version: 1.0.1
Summary: HPC Resource Allocation System 
Home-page: http://coldfront.io
Author: Andrew E. Bruno, Dori Sajdak, Mohammad Zia
License: GNU General Public License v3 (GPLv3)
Project-URL: Bug Tracker, https://github.com/ubccr/coldfront/issues
Project-URL: Documentation, https://ubccr.github.io/coldfront-docs/
Project-URL: Source Code, https://github.com/ubccr/coldfront
Keywords: high-performance-computing resource-allocation
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Framework :: Django :: 2.2
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: System :: Systems Administration
Classifier: Topic :: Internet :: WWW/HTTP :: WSGI :: Application
Description-Content-Type: text/markdown
Requires-Dist: arrow (==0.13.1)
Requires-Dist: bibtexparser (==1.1.0)
Requires-Dist: blessed (==1.15.0)
Requires-Dist: chardet (==3.0.4)
Requires-Dist: Django (==2.2.13)
Requires-Dist: django-crispy-forms (==1.7.2)
Requires-Dist: django-model-utils (==3.1.2)
Requires-Dist: django-picklefield (==2.0)
Requires-Dist: django-q (==1.0.1)
Requires-Dist: django-settings-export (==1.2.1)
Requires-Dist: django-simple-history (==2.7.2)
Requires-Dist: django-sslserver (==0.20)
Requires-Dist: django-su (==0.8.0)
Requires-Dist: doi2bib (==0.3.0)
Requires-Dist: future (==0.17.1)
Requires-Dist: humanize (==0.5.1)
Requires-Dist: idna (==2.8)
Requires-Dist: pyparsing (==2.3.1)
Requires-Dist: python-dateutil (==2.8.0)
Requires-Dist: python-memcached (==1.59)
Requires-Dist: pytz (==2018.9)
Requires-Dist: redis (==3.2.1)
Requires-Dist: requests (==2.22.0)
Requires-Dist: six (==1.12.0)
Requires-Dist: urllib3 (==1.24.2)
Requires-Dist: wcwidth (==0.1.7)

# ColdFront - Resource Allocation System

ColdFront is an open source resource allocation system designed to provide a
central portal for administration, reporting, and measuring scientific impact
of HPC resources. ColdFront was created to help HPC centers manage access to a
diverse set of resources across large groups of users and provide a rich set of
extensible meta data for comprehensive reporting. ColdFront is written in
Python and released under the GPLv3 license.

## Features

- Allocation based system for managing access to resources
- Collect Project, Grant, and Publication data from users
- Define custom attributes on resources and allocations
- Email notifications for expiring/renewing access to resources
- Integration with 3rd party systems for automation and access control
- Center director approval system and annual project reviews

## Plug-in Documentation
 - [Slurm](coldfront/plugins/slurm)
 - [FreeIPA](coldfront/plugins/freeipa)
 - [LDAP](coldfront/plugins/ldap_user_search)
 - [Mokey/Hydra OpenID Connect](coldfront/plugins/mokey_oidc)
 - [iQuota (Isilon)](coldfront/plugins/iquota)
 - [XDMoD](coldfront/plugins/xdmod)
 - [System Monitor](coldfront/plugins/system_monitor) (example of ways to integrate your own plug-ins)

## Contact Information
If you would like a live demo followed by QA, please contact us at ccr-coldfront-admin-list@listserv.buffalo.edu. You can also contact us for general inquiries and installation troubleshooting. 

If you would like to join our mailing list to receive news and updates, please send an email to listserv@listserv.buffalo.edu with no subject, and the following command in the body of the message:

subscribe ccr-open-coldfront-list@listserv.buffalo.edu first_name last_name


## Installation Demo
![Installation](coldfront/docs/source/user_guide/images/installation.gif "Installation")

[Click here for more demos](#demos)

## Quick Install

1. ColdFront requires Python 3.6, memcached, and redis. 

### CentOS (7)

Install EPEL then install required packages:

```
sudo yum install epel-release
sudo yum install python36 python36-devel memcached redis

# Install SQLite >= 3.8.3 from source since it is absent from the CentOS software repositories
wget https://sqlite.org/2020/sqlite-autoconf-XXXXXXX.tar.gz
tar -xzf sqlite-autoconf-XXXXXXX
cd sqlite-autoconf-XXXXXXX
./configure
make
make install

#Check version
sqlite3 --version
``` 


### CentOS (8)

Install EPEL then install required packages:

```
sudo yum install epel-release
sudo yum install python36 python36-devel memcached redis
``` 

### Ubuntu (16.04)
```
sudo add-apt-repository ppa:jonathonf/python-3.6
sudo apt-get update
sudo apt-get install python3.6 python3.6-venv memcached redis-server
``` 

2. Clone ColdFront in a new directory and create a Python virtual environment for ColdFront
```
mkdir coldfront_app
cd coldfront_app
git clone https://github.com/ubccr/coldfront.git
python3.6 -mvenv venv
```

3. Activate the virtual environment and install the required Python packages
```
source venv/bin/activate
cd coldfront
pip install wheel
pip install -r requirements.txt

```

4. Copy coldfront/config/local_settings.py.sample to coldfront/config/local_settings.py. 
```
cp coldfront/config/local_settings.py.sample coldfront/config/local_settings.py
```

5. Copy config/local_strings.py.sample to config/local_strings.py and update if desired. 
```
cp coldfront/config/local_strings.py.sample coldfront/config/local_strings.py
```

6. Run initial setup
```
python manage.py initial_setup
```

7. OPTIONAL: Add some test data
```
python manage.py load_test_data
```

8. Start development server
```
python manage.py runserver 0.0.0.0:8000
```

9. Point your browser to http://localhost:8000

You can log in as `admin` with password `test1234`. 
You can log in as a PI using username `cgray` with password `test1234`.
You can log in as another PI using username `sfoster` with password `test1234`.

Password for all users is also `test1234`. 


## Directory structure

- coldfront
    - core - The core ColdFront application
        - field_of_science
        - grant
        - portal
        - project
        - publication
        - resource
        - allocation
        - user
        - utils
    - libs - Helper libraries
    - plugins - Plugins that can be configured in ColdFront
        - freeipa
        - iquota
        - ldap_user_search
        - mokey_oidc
        - slurm
        - system_monitor



## <a name="demos"></a>ColdFront Demonstration

### Adding a Project
![Adding Project](coldfront/docs/source/user_guide/images/adding_project.gif "Adding a project")

### Adding Users
![Adding Users](coldfront/docs/source/user_guide/images/adding_users.gif "Adding Users")

### Requesting an Allocation
![Requesting an Allocation](coldfront/docs/source/user_guide/images/requesting_allocation.gif "Requesting an Allocation")

### Adding a Grant
![Adding a Grant](coldfront/docs/source/user_guide/images/adding_grant.gif "Adding a Grant")

### Adding Publications
![Adding Publications](coldfront/docs/source/user_guide/images/adding_publications.gif "Adding Publications")

### Adding a User to an Allocation
![Adding a User to Allocation](coldfront/docs/source/user_guide/images/adding_user_to_allocation.gif "Adding a User to an Allocation")

### Managing an Allocation as an Admin
![Managing an Allocation as and Admin](coldfront/docs/source/user_guide/images/managing_allocation.gif "Managing an Allocation as an Admin")

### Adding a Resource
![Adding a Resource](coldfront/docs/source/user_guide/images/adding_resource.gif "Adding a Resource")

### Generate Slurm Association Data 
![Generate Slurm Association Data](coldfront/docs/source/user_guide/images/slurm_dump.gif "Generate Slurm Association Data")

## License

ColdFront is released under the GPLv3 license. See the LICENSE file.


