Skip to content

Commit

Permalink
Merge branch 'master' into 1708-assignment-to-non-existent-vars
Browse files Browse the repository at this point in the history
  • Loading branch information
hchen99 committed Jul 9, 2024
2 parents 0e9fce6 + 3835379 commit a2d08fe
Show file tree
Hide file tree
Showing 43 changed files with 1,015 additions and 86 deletions.
1 change: 1 addition & 0 deletions .github/workflows/test_linux.yml
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,7 @@ jobs:
- cfg: { arch: rhel, arch_ver: 7 }
pkg_mgr: yum
conf_pkg: |
sed -i -e "s|mirrorlist=|#mirrorlist=|g" -e "s|#baseurl=http://mirror.centos.org|baseurl=http://vault.centos.org|g" /etc/yum.repos.d/CentOS-* &&
yum -y install epel-release
yum -y update
yum -y install wget
Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/test_macos.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ jobs:
- name: Install dependencies
run: |
# sudo installer -pkg /Library/Developer/CommandLineTools/Packages/macOS_SDK_headers_for_macOS_10.15.pkg -target /
brew update
brew upgrade || true
brew install --cask xquartz
brew install udunits openmotif maven
brew install swig
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ to accomodate the highest Child ID specified in the S_define file. Jobs without
will be executed by the parent process. Jobs with a C1 child specification will be executed by the
first child thread; jobs with a C2 specification will be executed by the second child thread; and so on.

Child Threads have three different scheduling choices. See Section XYZ for child thread scheduling
Child Threads have three different scheduling choices. See [Executive Scheduler](https://nasa.github.io/trick/documentation/simulation_capabilities/Executive-Scheduler) -> [Thread Control](https://nasa.github.io/trick/documentation/simulation_capabilities/Executive-Scheduler#thread-control) for child thread scheduling
details.

### Job Tagging
Expand Down
208 changes: 177 additions & 31 deletions docs/documentation/install_guide/Install-Guide.md

Large diffs are not rendered by default.

32 changes: 16 additions & 16 deletions docs/documentation/web/Webserver.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,17 +12,17 @@ adding a web server to your simulation simply requires including the CivetServer

## Configuration of the Web Server

The following (input.py) parameters are available to configure your web server:

|Parameter Name | Default Value | Description |
|---------------------------|---------------------------|-----------------------------------------------------------------|
|web.server.enable | False |Must be explicitly enabled |
|web.server.port | "8888" |Web servers “listen” port |
|web.server.document_root | "www" |Web servers document root |
|web.server.debug | False |Print Client/Server Communication. |
|web.server.ssl_enable | False |Encrypt traffic. Uses https instead of http. |
|web.server.path_to_ssl_cert|"~/.ssl/server.pem" |Path to your certificate. This is only used if ssl_enable = True|
|web.server.error_log_file | "civet_server_error.log" |CivetWeb error log file. |
The following (`input.py`) parameters are available to configure your web server:

|Parameter Name | Default Value | Description |
|---------------------------|---------------------------|-------------------------------------------------------------------|
|web.server.enable | `False` |Must be explicitly enabled |
|web.server.port | `8888` |Web servers “listen” port |
|web.server.document_root | `"www"` |Web servers document root |
|web.server.debug | `False` |Print Client/Server Communication. |
|web.server.ssl_enable | `False` |Encrypt traffic. Uses https instead of http. |
|web.server.path_to_ssl_cert|`"~/.ssl/server.pem"` |Path to your certificate. This is only used if `ssl_enable = True`|
|web.server.error_log_file |`"civet_server_error.log"` |CivetWeb error log file. |

For your web server to be active, you must at least specify the following :

Expand All @@ -31,10 +31,10 @@ web.server.enable = True

```

To have your web server listen on port 8890, rather than 8888, you would specify:
To have your web server listen on port `8890`, rather than `8888`, you would specify:

```python
web.server.port = "8890"
web.server.port = 8890
```

To serve files from a directory called ```my_document_root```, rather than ```www```:
Expand All @@ -50,11 +50,11 @@ web.server.debug = True
```

## When the Web Server Starts
The web server, if enabled, will start during sim initialization. When it does, it will look for the specified document root directory. By default that’s “www”. If root directory doesn’t exist, one will be created with a simple index.html file , a style sheet, and a couple of directories.
The web server, if enabled, will start during sim initialization. When it does, it will look for the specified document root directory. By default that’s `“www”`. If root directory doesn’t exist, one will be created with a simple `index.html` file , a style sheet, and a couple of directories.


## Connecting to Your Web Server
Assuming that you accepted the default port, connect to ```http://localhost:8888/``` (```https://localhost:8888/``` if ssl_enable=True) from your web browser. This will display the index.html file in your root directory.
Assuming that you accepted the default port, connect to ```http://localhost:8888/``` (```https://localhost:8888/``` if `ssl_enable=True`) from your web browser. This will display the `index.html` file in your root directory.


## The Default Document Root Directory
Expand All @@ -69,7 +69,7 @@ www/
images/
```

**index.html** is the file that’s displayed when you connect to http://localhost:8888/.
**index.html** is the file that’s displayed when you connect to `http://localhost:8888/`.

**style.css** is a CSS style-sheet that’s included by index.html to give it some pizzazz.

Expand Down
1 change: 1 addition & 0 deletions docs/howto_guides/How-To-Guides.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@
01. [How to Containerize Trick with Docker](How-To-Containerize-Trick-with-Docker)
01. [How to Setup a Virtual Python Environment](How-To-Python-Virtual-Environment)
01. [Checkpointing Best Practices](Checkpointing-Best-Practices)
01. [Realtime Best Practices](Realtime-Best-Practices)
Loading

0 comments on commit a2d08fe

Please sign in to comment.