Skip to content

Commit

Permalink
readme, mod fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
Randall C. O'Reilly committed Dec 10, 2021
1 parent 881eff9 commit e0f2823
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ newproj-server <projname> calls: newproj projname on server -- use in existin
# Overview

* There are different **projects**, which are typically named by the name of the current working directory on your laptop (*client*) where you run the `grunt` commands -- these have the code you want to run on the *server*. These projects can be anywhere, but the code you want to run *must be added to a git repository* (e.g., hosted on `github.com` or anywhere) -- the list of files copied up to the server is provided by the git list for the current directory. This allows misc other temp result, doc, etc files to exist in the directory. It also means that you should put any other files that are not essential for running the simulation in other directories.
+ If you have a `grunt.projnm` file in the current dir, its contents determines the project name instead.
+ If you have a `grunt.projname` file in the current dir, its contents determines the project name instead.

* Each project has its own grunt git repositories ( *entirely separate from your "local" e.g., github repository* ), on the server and client, and the client configures the server's bare repositories as the ssh remote origin for the local working copies. Repositories on server live under `~/gruntsrv/` and client on `~/gruntdat/` -- *do not put this grunt code in those locations!* -- we recommend `~/emer/grunt`. There are two repositories per project:
+ `jobs` contains all the job running and status files. On the server, it is also where results are typically saved (log files etc), but they are not added to git.
Expand Down Expand Up @@ -266,7 +266,7 @@ Take some time to read over the script -- the top has the key variables that you

You will have to read your server's documentation and edit the python code to generate an appropriate `sbatch` submission script depending on details of your server. The example `grunter.py` file contains some tips and options that work across the two servers we use.

You can have the script `cd` into a subdirectory and run a project from there, to support multiple different executables or variations in the same repository, but *always run grunt from the root of the project* because it gets the project name from the directory name (and even if you put `grunt.projnm` in the subdirectory to fix that issue, the jobs.* files etc will not be coordinated if you run grunt from different directories -- it might work but could get confusing at least).
You can have the script `cd` into a subdirectory and run a project from there, to support multiple different executables or variations in the same repository, but *always run grunt from the root of the project* because it gets the project name from the directory name (and even if you put `grunt.projname` in the subdirectory to fix that issue, the jobs.* files etc will not be coordinated if you run grunt from different directories -- it might work but could get confusing at least).

Also, if there are any "external" resources that your job needs (e.g., large shared databases of image files), you should just write a command in your sbatch script to make a symbolic link to the relevant directory ( *on the server* ), and then have your project refer "locally" to that symlinked directory -- you can also manually create the same symlink on your client, so the code will run the same in both places, and others can use it too, without baking in a specific path in the code.

Expand Down
2 changes: 1 addition & 1 deletion go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ module github.com/emer/grunt
go 1.15

require (
github.com/emer/etable v1.0.37
github.com/emer/etable v1.0.38
github.com/goki/gi v1.2.15
github.com/goki/ki v1.1.4
)
4 changes: 2 additions & 2 deletions go.sum
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,8 @@ github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/dlclark/regexp2 v1.4.0 h1:F1rxgk7p4uKjwIQxBs9oAXe5CqrXlCduYEJvrF4u93E=
github.com/dlclark/regexp2 v1.4.0/go.mod h1:2pZnwuY/m+8K6iRw6wQdMtk+rH5tNGR1i55kozfMjCc=
github.com/emer/etable v1.0.37 h1:HueDXgM9LLpyI7nQo5WdNU5SaZF4K7JQnsUcF5iB8DM=
github.com/emer/etable v1.0.37/go.mod h1:ZAUxQL6J4f9iJd6uUw6xy35pKZNg0kOGU9ychrz90Io=
github.com/emer/etable v1.0.38 h1:FhJR2x7gHrdydNecDYwr/7FZzovhewXbOuuVoT5UJyQ=
github.com/emer/etable v1.0.38/go.mod h1:ZAUxQL6J4f9iJd6uUw6xy35pKZNg0kOGU9ychrz90Io=
github.com/envoyproxy/go-control-plane v0.9.0/go.mod h1:YTl/9mNaCwkRvm6d1a2C3ymFceY/DCBVvsKhRF0iEA4=
github.com/envoyproxy/go-control-plane v0.9.1-0.20191026205805-5f8ba28d4473/go.mod h1:YTl/9mNaCwkRvm6d1a2C3ymFceY/DCBVvsKhRF0iEA4=
github.com/envoyproxy/go-control-plane v0.9.4/go.mod h1:6rpuAdCZL397s3pYoYcLgu1mIlRU8Am5FuJP05cCM98=
Expand Down

0 comments on commit e0f2823

Please sign in to comment.