utfile
This commit is contained in:
		
							
								
								
									
										14
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										14
									
								
								README.md
									
									
									
									
									
								
							@@ -13,8 +13,18 @@ which will place a binary at `build/nstrophy`.
 | 
			
		||||
 | 
			
		||||
The syntax for the execution of Nstrophy is
 | 
			
		||||
```bash
 | 
			
		||||
./build/nstrophy [-p parameters] [-s savefile] <command>
 | 
			
		||||
./build/nstrophy [-p parameters] [-s savefile] [-u u_outfile] <command>
 | 
			
		||||
```
 | 
			
		||||
* `parameters` is a list of parameters for the computation, see
 | 
			
		||||
  [Parameters](#parameters)
 | 
			
		||||
 | 
			
		||||
* `savefile` is a file where the last step of the computation is saved in
 | 
			
		||||
  binary format so that the computation can be resumed after it has terminated,
 | 
			
		||||
  see
 | 
			
		||||
  [Interrupting and resuming the computation](#interrupting-and-resuming-the-computation).
 | 
			
		||||
 | 
			
		||||
* `u_outfile` is a file to which the final u is written in plain text format,
 | 
			
		||||
  which can be used as an initial condition for a future computation.
 | 
			
		||||
 | 
			
		||||
Nstrophy is written in C. The Makefile uses the GNU C Compiler.
 | 
			
		||||
 | 
			
		||||
@@ -114,7 +124,7 @@ should be a `;` sperated list of `key=value` pairs. The possible keys are
 | 
			
		||||
  norm.
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
# Interrupting/resuming the computation
 | 
			
		||||
# Interrupting and resuming the computation
 | 
			
		||||
 | 
			
		||||
The computation can be interrupted by sending Nstrophy the `SIGINT` signal
 | 
			
		||||
(e.g. by pressing `Ctrl-C`.) When Nstrophy receives the `SIGINT` signal, it
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user