Merge pull request #187 from nasa/dev

Release v1.6.1

Author: John P. Lucas

.gitattributes

@@ -0,0 +1,5 @@
+# Set the default behavior, in case people don't have core.autocrlf set.
+* text eol=lf
+
+# Declare files that will always have LF line endings on checkout.
+*.sh text eol=lf

.gitignore

@@ -10,3 +10,4 @@
 build
 *.o
 support/nos3_install.log
+tmp

.gitmodules

@@ -46,9 +46,6 @@
 [submodule "sims/sim_common"]
 	path = sims/sim_common
 	url = https://github.com/nasa-itc/sim_common.git
-[submodule "sims/sim_server"]
-	path = sims/sim_server
-	url = https://github.com/nasa-itc/sim_server.git
 [submodule "sims/sim_terminal"]
 	path = sims/sim_terminal
 	url = https://github.com/nasa-itc/sim_terminal.git
@@ -104,3 +101,35 @@
 	path = fsw/apps/fm
 	url = https://github.com/nasa-itc/FM.git
 	branch = nos3-main
+[submodule "components/generic_fss"]
+	path = components/generic_fss
+	url = https://github.com/nasa-itc/generic_fss.git
+	branch = main
+[submodule "components/generic_css"]
+	path = components/generic_css
+	url = https://github.com/nasa-itc/generic_css.git
+	branch = main
+[submodule "components/generic_eps"]
+	path = components/generic_eps
+	url = https://github.com/nasa-itc/generic_eps.git
+	branch = main
+[submodule "components/generic_torquer"]
+	path = components/generic_torquer
+	url = https://github.com/nasa-itc/generic_torquer.git
+	branch = main
+[submodule "components/generic_radio"]
+	path = components/generic_radio
+	url = https://github.com/nasa-itc/generic_radio.git
+	branch = main
+[submodule "components/generic_imu"]
+	path = components/generic_imu
+	url = https://github.com/nasa-itc/generic_imu.git
+	branch = main
+[submodule "components/generic_mag"]
+	path = components/generic_mag
+	url = https://github.com/nasa-itc/generic_magnetometer.git
+	branch = main
+[submodule "components/cryptolib"]
+	path = components/cryptolib
+	url = https://github.com/nasa/CryptoLib.git
+	branch = main

CONTRIBUTING.md

@@ -0,0 +1,108 @@
+# NASA Operational Simulator for Small Satellites (NOS3) Contributing Guide
+
+So you'd like to contribute to NOS3? 
+Below are some guidelines for contributors to follow in addition to a standard [code of conduct](https://www.contributor-covenant.org/version/1/4/code-of-conduct/). 
+Contributions come in all shapes and sizes. 
+We appreciate your help with documentation, unit tests, framework code, continuous-integration, or simply reporting bugs and improvement ideas. 
+We can't promise that we'll accept every suggestion or fix every bug in a timely manner but we'll respond to you as quickly as possible.
+
+* [Code of Conduct](#CodeofConduct)
+* [Ways to Contribute](#WaystoContribute)
+	* [Discussions and Questions](#DiscussionsandQuestions)
+	* [Bug Reports](#BugReports)
+		* [Before Reporting a Bug](#BeforeReportingaBug)
+		* [Reporting a Bug](#ReportingaBug)
+		* [What Happens to my Bug Report?](#WhatHappenstomyBugReport)
+	* [New Feature Requests](#NewFeatureRequests)
+		* [Before Requesting a New Feature](#BeforeRequestingaNewFeature)
+		* [Requesting a New Feature](#RequestingaNewFeature)
+		* [What Happens to my Feature Request?](#WhatHappenstomyFeatureRequest)
+	* [Pull Requests](#PullRequests)
+		* [Before starting your Pull Request](#BeforestartingyourPullRequest)
+		* [Creating a Pull Request](#CreatingaPullRequest)
+		* [What Happens to My Pull Request?](#WhatHappenstoMyPullRequest)
+
+## <a name='WaystoContribute'></a>Ways to Contribute
+
+### <a name='DiscussionsandQuestions'></a>Discussions and Questions
+
+For discussions, questions, or ideas, [start a new discussion](https://github.com/nasa/nos3/discussions/new) in the cFS repository under the Discussions tab. If you prefer email, you can also [join the cfs community mailing list](README.md#join-the-mailing-list).
+
+### <a name='BugReports'></a>Bug Reports
+
+#### <a name='BeforeReportingaBug'></a>Before Reporting a Bug
+Perform a cursory search to see if the bug has already been reported.
+If a bug has been reported and the issue is still open, add a comment to the existing issue instead of opening a new one.
+
+#### <a name='ReportingaBug'></a>Reporting a Bug
+
+If you find a bug in our code don't hesitate to report it:
+
+1. Open an issue using the bug report template.
+2. Describe the issue.
+3. Describe the expected behavior if the bug did not occur.
+4. Provide the reproduction steps that someone else can follow to recreate the bug or error on their own.
+5. If applicable, add code snippets or references to the software.
+6. Provide the system the bug was observed on including the hardware, operating system, and versions.
+7. Provide any additional context if applicable.
+8. Provide your full name or GitHub username and your company organization if applicable.
+
+#### <a name='WhatHappenstomyBugReport'></a>What Happens to my Bug Report?
+
+1. The NOS3 team will label the issue.
+2. A team member will try to reproduce the issue with your provided steps. If the team is able to reproduce the issue, the issue will be left to be implemented by someone.
+
+### <a name='NewFeatureRequests'></a>New Feature Requests
+
+NOS3 has a multitude of users from different fields and backgrounds. We appreciate your ideas for enhancements! 
+
+#### <a name='BeforeRequestingaNewFeature'></a>Before Requesting a New Feature
+
+Perform a cursory search to see if the feature has already been requested. 
+If a feature request has been reported and the issue is still open, add a comment to the existing issue instead of opening a new one.
+
+#### <a name='RequestingaNewFeature'></a>Requesting a New Feature
+
+1. Open an issue using the feature request template.
+2. Describe the feature.
+3. Describe the solution you would like.
+4. Describe alternatives you've considered.
+5. Provide any additional context if applicable.
+6. Provide your full name or GitHub username and your company organization if applicable.
+
+#### <a name='WhatHappenstomyFeatureRequest'></a>What Happens to my Feature Request?
+
+1. The project team will label the issue.
+2. The project team will evaluate the feature request, possibly asking you more questions to understand its purpose and any relevant requirements. If the issue is closed, the team will convey their reasoning and suggest an alternative path forward.
+3. If the feature request is accepted, it will be marked for implementation.
+
+### <a name='PullRequests'></a>Pull Requests
+
+#### <a name='BeforestartingyourPullRequest'></a>Before starting your Pull Request
+
+Ready to Add Your Code? Follow GitHub's fork-branch-pull request pattern.
+
+1. Fork the relevant component.
+
+2. Find the related issue number or create an associated issue that explains the intent of your new code. 
+
+3. Create a new branch in your fork to work on your fix. We recommend naming your branch `fix-ISSUE_NUMBER-<FIX_SUMMARY>`.
+
+3. Add commits to your branch. For information on commit messages, review [How to Write a Git Commit Message](https://chris.beams.io/posts/git-commit/).
+
+#### <a name='CreatingaPullRequest'></a>Creating a Pull Request
+
+We recommend creating your pull-request as a "draft" and to commit early and often so the community can give you feedback at the beginning of the process as opposed to asking you to change hours of hard work at the end.
+
+1. For the title, use the title convention `Fix #XYZ, SHORT_DESCRIPTION`.
+2. Describe the contribution. First document which issue number was fixed using the template "Fix #XYZ". Then describe the contribution.
+3. Provide what testing was used to confirm the pull request resolves the link issue. If writing new code, also provide the associated coverage unit tests. 
+4. Provide the expected behavior changes of the pull request.
+5. Provide the system the bug was observed on including the hardware, operating system, and versions.
+6. Provide any additional context if applicable.
+7. Provide your full name or GitHub username and your company or organization if applicable.
+
+#### <a name='WhatHappenstoMyPullRequest'></a>What Happens to My Pull Request?
+
+1. The NOS3 team will label and evaluate the pull request in the next configuration control board meeting.
+2. If the pull request is accepted, it will be merged.

Makefile

@@ -27,7 +27,7 @@ endif
 
 # The "LOCALTGTS" defines the top-level targets that are implemented in this makefile
 # Any other target may also be given, in that case it will simply be passed through.
-LOCALTGTS := all fsw fsw-prep pack sim sim-prep clean clean-fsw clean-sim gsw launch log real-clean stop
+LOCALTGTS := all fsw fsw-prep pack sim sim-prep clean clean-fsw clean-sim checkout gsw launch log real-clean stop sc-launch
 OTHERTGTS := $(filter-out $(LOCALTGTS),$(MAKECMDGOALS))
 
 # As this makefile does not build any real files, treat everything as a PHONY target
@@ -79,6 +79,9 @@ clean-sim:
 #
 # Script Calls
 #
+checkout:
+	./gsw/scripts/checkout.sh
+
 gsw:
 	./gsw/scripts/gsw.sh
 
@@ -92,5 +95,8 @@ real-clean:
 	$(MAKE) clean
 	./gsw/scripts/real_clean.sh
 
+sc-launch:
+	./gsw/scripts/sc_launch.sh
+
 stop:
 	./gsw/scripts/stop.sh

README.md

@@ -7,9 +7,9 @@ The best source of documentation can be found at [the wiki](https://github.com/n
 
 ### Prerequisites
 Each of the applications listed below are required prior to performing the installation procedure:
-* [Git 1.8+](https://git-scm.com/)
-* [Vagrant 2.2.3+](https://www.vagrantup.com/)
-* [VirtualBox 6.1+](https://www.virtualbox.org/)
+* [Git 2.36+](https://git-scm.com/)
+* [Vagrant 2.3.4+](https://www.vagrantup.com/)
+* [VirtualBox 7.0+](https://www.virtualbox.org/)
 
 ### Installing
 1. Clone the repository `git clone https://github.com/nasa/nos3.git`
@@ -21,8 +21,10 @@ Each of the applications listed below are required prior to performing the insta
 6. Try building and running following the instructions below
 
 ### Getting started
-It is recommended to share the nos3 repository into the virtual machine (e.g. `/home/nos3/Desktop/github-nos3`)
-1. Open a terminal (to `/home/nos3/Desktop/github-nos3`)
+By default the nos3 repository is shared into the virtual machine at `/home/nos3/Desktop/github-nos3`
+1. Open a terminal
+2. Navigate to the nos3 repository
+  - `cd /home/nos3/Desktop/github-nos3`
 2. To build use the `make` command from the nos3 repo
 3. To run nos3 use the `make launch` command from the nos3 repo
 4. To halt nos3 use the `make stop` command from the nos3 repo
@@ -45,7 +47,6 @@ It is recommended to share the nos3 repository into the virtual machine (e.g. `/
 	- /cfg - 42 configuration files and NOS3 top level configuration files
 	- /nos_time_driver - time syncronization for all components
 	- /sim_common - common files used by component simulators including the files that define the simulator plugin architecture
-	- /sim_server - NOS Engine Server config and build files
 	- /sim_terminal - terminal for testing on NOS Engine busses
 	- /truth_42_sim - interface between 42 and COSMOS to provide dynamics truth data to COSMOS
 

Vagrantfile

@@ -5,16 +5,19 @@ Vagrant.configure("2") do |config|
     config.vm.box = "nos3/ubuntu"
 
     ### Specify version
-    config.vm.box_version = "0.0.0"
+    config.vm.box_version = "1.6.1"
 
     ### Share host NOS3 repository into VM
-    config.vm.synced_folder ".", "/home/nos3/Desktop/github-nos3"
+    config.vm.synced_folder ".", "/home/nos3/Desktop/github-nos3", 
+        owner: 'root', group:'vboxsf', automount:'true', 
+        mount_options: ["dmode=0770", "fmode=0770"]
 
     ### General configuration
     config.vm.provider "virtualbox" do |vbox|
-        vbox.name = "nos3_1.5.2"
+        vbox.name = "nos3_1.6.1"
         vbox.gui = true
-        #vbox.cpus = 2
-        #vbox.memory = "8192"
+        ### Enable additional configuration as needed
+        #vbox.cpus = 8
+        #vbox.memory = "16384"
     end
 end