Skip to content

Commit

Permalink
Duplicate development branch
Browse files Browse the repository at this point in the history
Duplicate CORA_TASK20/7.3-AD2-NewRequirements branch from the development repository. Update License to GPLv3.
  • Loading branch information
stephen-okazawa-gc committed Oct 16, 2023
1 parent c57044d commit 584bc01
Show file tree
Hide file tree
Showing 637 changed files with 215,299 additions and 2 deletions.
7 changes: 7 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# virtual environment folder
venv*/
# compiled bytecode
**/__pycache__/
**/*.pyc
# Simulation result folders
**/batch_202*
674 changes: 674 additions & 0 deletions LICENSE

Large diffs are not rendered by default.

60 changes: 58 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,58 @@
# OS_ORIGAME
ORIGAME is a Python-based discrete event modelling and simulation environment. It has a full-featured graphical user interface (GUI) in which users build models and run Monte Carlo simulations.
# ORIGAME
Private repository for ORIGAME simulation software.

This repository was created for a Government of Canada contract to update the ORIGAME code base.

(c) Her Majesty the Queen in Right of Canada

## LICENSE
See LICENSE file.

## RECOMMENDED INSTALLATION

These instructions are for running ORIGAME on python 3.8 and 3.11

1. Install Python 3.8.10 (python-3.8.10-amd64.exe)
- https://www.python.org/downloads/release/python-3810/

2. Install Python 3.11.2 (python-3.11.2-amd64.exe)
- https://www.python.org/downloads/release/python-3112/

3. Install Visual C++ Redistributable for Visual Studio 2015 (vc_redist.x64.exe)
- https://www.microsoft.com/en-ca/download/details.aspx?id=48145

4. Clone or download ORIGAME to a project folder on your system

5. From the project folder, create a virtual environment for ORIGAME for each Python version
- e.g. `C:\Python38\python -m venv venv8`
- e.g. `C:\Python311\python -m venv venv11`

6. Activate a virtual environment and install dependencies in "requirements.txt". Deactivate the virtual environment
if not in use.
- `venv11\Scripts\activate`
- `pip install -r requirements.txt`
- `deactivate`

7. Activate the desired virtual environment, and launch ORIGAME GUI.
- `venv11\Scripts\activate`
- `py .\origame_gui.py`

Visit this [this page](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/#activating-a-virtual-environment) for more information about virtual environments.

## DOCUMENTATION

The ORIGAME User Manual and ORIGAME Tutorial documents are located in the /origame/docs folder.

## TESTING

A number of test scenarios and run procedures are provided in the /testing folder.

These test scenarios constitute Government Supplied Material 2 (GSM 2), referred to in the task Statement of Work.

## CONTACT

Stephen Okazawa<br/>
Defence Scientist<br/>
Defence Research and Development Canada<br/>
[email protected]<br/>

60 changes: 60 additions & 0 deletions origame/LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
************************
ORIGAME SOFTWARE LICENSE
************************


Ownership and Administration
============================

The ORIGAME software and all accompanying documentation and material (hereinafter
called "the Software") are subject to copyright, with all rights reserved to Her
Majesty the Queen in Right of Canada.

The Software is administered by Defence Research & Development Canada (DRDC), located at
60 Moodie Drive, Ottawa, Ontario, K1A 0K2.


Approved Users
==============

The Software may only be used by the following individuals (hereinafter called "Approved Users"):

1. Employees of the Government of Canada.

2. Contractors that are currently engaged in a contract with the Government of
Canada and that have a requirement to use the Software in the execution of their work
for the Government of Canada.

Individuals other than Approved Users may not use the Software and must destroy any copies of the
Software in their possession unless they have obtained prior written permission from DRDC to use
the Software.


Approved Use
============

Users of the Software must adhere to the following restrictions regarding their use
of the Software (herinafter called "Approved Use"):

1. The Software must only be used to support the execution of work
for the Government of Canada.

2. The Software must not be modified without prior written permission from DRDC.

3. The Software must not be provided to others unless the recipients are
Approved Users and their use of the Software adheres with the Approved Use.

4. Contractors must further adhere to the terms of their contract with the
Government of Canada with respect to their use of the Software.


Contact
=======

Stephen Okazawa
Defence Scientist, DRDC
101 Colonel By Drive, Ottawa, Ontario, K1A 0K2
Tel.: (613) 901-9772
E-mail: [email protected]


25 changes: 25 additions & 0 deletions origame/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# This file is part of Origame. See the __license__ variable below for licensing information.
#
# This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
# WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
#
# For coding standards that apply to this file, see the project's Coding Standards document,
# r4_coding_standards.html, in the project's docs/CodingStandards/html folder.

"""
*Project - R4 HR TDP*: This package provides functionality related to running either variant of
the Origame application.
Version History: See SVN log.
"""

# -- Meta-data ----------------------------------------------------------------------------------

__version__ = "$Revision: 5788$"

__license__ = """This file can ONLY be copied, used or modified according to the terms and conditions
described in the LICENSE.txt located in the root folder of the Origame package."""
__copyright__ = "(c) Her Majesty the Queen in Right of Canada"

# -- PUBLIC API ---------------------------------------------------------------------------------
# import *public* symbols (classes/functions/constants) from contained modules:
28 changes: 28 additions & 0 deletions origame/batch_sim/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# This file is part of Origame. See the __license__ variable below for licensing information.
#
# This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
# WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
#
# For coding standards that apply to this file, see the project's Coding Standards document,
# r4_coding_standards.html, in the project's docs/CodingStandards/html folder.

"""
*Project - R4 HR TDP*: This package provides functionality related to batch simulations in either variant of Origame.
Version History: See SVN log.
"""

# -- Meta-data ----------------------------------------------------------------------------------

__version__ = "$Revision: 5788$"

__license__ = """This file can ONLY be copied, used or modified according to the terms and conditions
described in the LICENSE.txt located in the root folder of the Origame package."""
__copyright__ = "(c) Her Majesty the Queen in Right of Canada"

# -- PUBLIC API ---------------------------------------------------------------------------------
# import *public* symbols (classes/functions/constants) from contained modules:

from .batch_sim_manager import BatchSimManager, BatchSimSettings, BsmStatesEnum, BatchDoneStatusEnum
from .batch_sim_manager import MIN_REPLIC_ID, MIN_VARIANT_ID
from .seed_table import SeedTable
Loading

0 comments on commit 584bc01

Please sign in to comment.