Commit Graph

91 Commits

Author SHA1 Message Date
Chris McCarthy
196d8855c3 #1647 - Added _PrimaitePaths class that manages all the primaite locations using PlayformDirs. This class now creates new primaite locations for each version of primaite.
- Rolled the _PrimaitePaths class out throughout the code base.
- Updated the docs to reference the new version paths.
- Updated the author from qinetiq to dstl
- Bumped version number to 2.0.0rc2
2023-07-21 14:00:50 +01:00
Brian Kanyora
69e7b23d2c feature/1641:
Changed environment config to training config
2023-07-20 16:09:57 +01:00
SunilSamra
6ce816f2e1 #1640 - Added --ldc and --tc prefixes and added small note about primaite session default run command 2023-07-20 14:45:55 +01:00
Chris McCarthy
713aa279ec Merge branch 'dev' into feature/1635_Update_Primaite_Session_page_in_Docs
# Conflicts:
#	src/primaite/setup/old_installation_clean_up.py
#	src/primaite/setup/reset_example_configs.py
2023-07-18 11:36:31 +01:00
Chris McCarthy
e070b247b1 #1635 - Updated the session outputs details in primaite_session.rst
- Fixed Logger typehint bugs
2023-07-18 11:34:41 +01:00
Marek Wolan
9e3285350a Get tests working with new ACL changes 2023-07-18 11:16:39 +01:00
Marek Wolan
c5f612889e Merge remote-tracking branch 'origin/dev' into feature/901-change-functionality-acl-rules 2023-07-18 10:55:31 +01:00
Chris McCarthy
81295a4fc4 #1631 - Updated the copyright statement to comply with DEFCON 703 Edition 08/13 2023-07-17 19:57:34 +01:00
SunilSamra
a2f43b5abc #901 - merged dev into branch 2023-07-17 19:54:07 +01:00
Chris McCarthy
2d1a1e6db7 #1631 - Added the DEFCON 703 header to all possible files 2023-07-17 19:28:43 +01:00
SunilSamra
57157db08c Merge remote-tracking branch 'origin/dev' into feature/901-change-functionality-acl-rules 2023-07-17 15:51:01 +01:00
Czar Echavez
39b30460cd Merge branch 'dev' into feature/1595-finalise-and-test-the-loading-of-trained-agents 2023-07-17 15:23:46 +01:00
Sunil Samra
cc09fe9079 Removed apply_implicit_rule comment 2023-07-17 12:45:31 +00:00
SunilSamra
78d7f39342 #901 - Removed flatten from training configs
- Added flatten operation in observations.py when there are multiple obs components
- Updated config.rst docs
2023-07-17 13:44:16 +01:00
SunilSamra
da20c0e9e6 #901
- Removed bool apply_implicit_rule
- Set default implicit_rule to EXPLICIT DENY
- Added position to ACLs in laydown configs
- Removed apply_implicit_rule from training configs
2023-07-17 13:00:58 +01:00
Brian Kanyora
9a0b14b111 Merge remote-tracking branch 'origin/dev' into feature/1597-Getting-Started 2023-07-17 10:33:59 +01:00
Brian Kanyora
50697c6f75 Apply suggestions from code review 2023-07-17 09:23:11 +00:00
SunilSamra
9df8d132fc #901 - added to config.rst and added new ACL main config options 2023-07-17 10:08:12 +01:00
Czar Echavez
7c2ff55da2 #1595: added loading sessions to run command + test + documentation for how to use loading sessions 2023-07-14 15:51:38 +01:00
Brian Kanyora
fd2ab39edf feature/1597:
Added dependencies to the index.rst since v1.1.0.
2023-07-13 09:36:04 +01:00
Brian Kanyora
f5e1ef7491 feature/1597:
Added dependencies to the index.rst since v1.1.0.
2023-07-13 09:35:42 +01:00
Marek Wolan
c61770825a Merged PR 116: Update documentation
## Summary
* Update observation space information and standardise formatting of code blocks in that section
* Remove non-ascii quotation characters
* Update custom blue agent page to match new AgentSession classes.
* Introduce glossary
* Provide a first draft of migration guide for 1.2 to 2.0 (probably not comprehensive)

## Test process
Sphinx is able to build the documentation as checked on my local machine

## Checklist
- [x] This PR is linked to a **work item**
- [x] I have performed **self-review** of the code
- [ ] I have written **tests** for any new functionality added with this PR
- [x] I have updated the **documentation** if this PR changes or adds functionality
- [x] I have run **pre-commit** checks for code style

Related work items: #1602
2023-07-12 14:28:41 +00:00
Marek Wolan
c7547f715e Add better hyperlinks 2023-07-12 09:16:40 +01:00
Chris McCarthy
3c20764096 #1597 - Fixed Project Links side bar 2023-07-11 15:50:37 +01:00
Chris McCarthy
5b3663c3cf #1597 - Added code tabs to getting started page 2023-07-11 15:47:13 +01:00
Brian Kanyora
30d8478a78 Addressing Sunils comments from my 2023-07-11 13:49:01 +01:00
SunilSamra
585d35338f 1566 - updated docs for new items in training_config 2023-07-11 12:40:25 +01:00
Marek Wolan
6a888d2efe Updated migration guide 2023-07-11 12:10:20 +01:00
Marek Wolan
5f6bc32b98 Added draft migration guide. 2023-07-11 12:01:48 +01:00
Marek Wolan
9e936513d5 Improved order of glossary terms 2023-07-11 11:31:29 +01:00
Marek Wolan
dc26863216 Completed glossary 2023-07-11 11:13:28 +01:00
Marek Wolan
56fd9c4d0a Merge remote-tracking branch 'origin/dev' into feature/1602-update-docs 2023-07-11 10:12:40 +01:00
Marek Wolan
a07ce00852 Added glossary 2023-07-11 09:56:52 +01:00
Brian Kanyora
5939fda2ba Merge remote-tracking branch 'origin/dev' into feature/1597-Getting-Started
# Conflicts:
#	docs/source/primaite-dependencies.rst
2023-07-10 15:48:32 +01:00
Brian Kanyora
ecc06a5db0 feature/1597:
pre commit fix
2023-07-10 15:41:50 +01:00
Marek Wolan
30bcdba429 Finished writing custom agent example. 2023-07-10 14:56:06 +01:00
Marek Wolan
5ec8d3c8c1 Merged PR 110: Update Observation spaces description
## Summary
This minor update adds more detail and links to relevant pages within the API docs.

## Test process
Locally built docs in HTML format to verify all content displays correctly.

Related work items: #1596
2023-07-10 10:20:42 +00:00
Marek Wolan
43a4f93626 Changed order of text in custom agent docs 2023-07-10 11:19:47 +01:00
Brian Kanyora
3c9b8a272a Additional syntax changes 2023-07-10 10:28:27 +01:00
Brian Kanyora
e3ad1470df feature/1597:
Small syntax changes
2023-07-10 10:01:25 +01:00
Marek Wolan
0145532103 Update docs 2023-07-09 20:23:53 +01:00
Brian Kanyora
23adc740cd Resolved more syntax errors 2023-07-07 16:32:35 +01:00
Brian Kanyora
752a611b89 Fixed the rst syntax 2023-07-07 16:25:55 +01:00
Marek Wolan
d7bf678b1f Reworded observation description 2023-07-07 14:24:37 +01:00
Marek Wolan
bbb305d561 Update observation space documentation 2023-07-07 13:52:14 +01:00
Brian Kanyora
4ef7831bfa Added a getting started file 2023-07-07 11:37:57 +01:00
Marek Wolan
7e0eee5d73 Merge remote-tracking branch 'origin/dev' into feature/1572-fix-docs-formatting 2023-07-07 10:30:11 +01:00
Czar Echavez
04e52453b1 Merge branch 'dev' into feature/1386-enable-a-repeatable-or-deterministic-baseline-test 2023-07-06 22:22:37 +01:00
Marek Wolan
2a08d3a2a5 Removed reference to file that no longer exists 2023-07-06 15:18:49 +01:00
Marek Wolan
82a5122276 Add __init__ to class special members doc 2023-07-06 15:18:33 +01:00