mesa_script 0.1 → 0.1.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +12 -3
  3. data/lib/mesa_script.rb +8 -2
  4. metadata +1 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: ca9b7036396472f5a9ea98119ef282a875bac4e8
4
- data.tar.gz: 6e2c6f0ffa3ef59365fd03815ea81b88fa5b316c
3
+ metadata.gz: 55896301a082301610d80908f4c961af244e4a73
4
+ data.tar.gz: efd7bc215b3b3d2a856159695952c2e24654ea6f
5
5
  SHA512:
6
- metadata.gz: 46b15cee048454f84c79bfc6deaafe9356b91cfd60959599b7d874ab3a80194118d88e19c91b0ce26e9084933c65f52f8f37624b0f56a2c40b9fab78c75c5f0e
7
- data.tar.gz: 28b1bc30eec9a956f760b30fda344c54f869f266fc94cc305c5893ce704efe9d13c629ba32256730dcadd799966faff035250b3f0547880604d7bfc92a3c772f
6
+ metadata.gz: f279cea9e1082ef5b5066854e2377214e725a5cff6f53ede2802bbc3d4762875d4c5339d99054fde80c7b2690bda64e8cb596ad10aa12a64084ec5f29720c79c
7
+ data.tar.gz: 49da8ec75ef95dc5878f6cd8c9b42d6dfce1585a2761c32934e05c9a1224d92e35cadfb99b23330c9f56287f4d3b2d801d2c0d8a8425aee0e66c75757be2e2a7
data/README.md CHANGED
@@ -44,9 +44,18 @@ set of parameters, run MESA star, then use the output of that run to dictate a
44
44
  new inlist and run, creating a chain (maybe a MESA root find of sorts).
45
45
 
46
46
  ###Installation
47
- Someday, I hope to package this as a gem, but for now, it's staying hosted on
48
- Github, which means you need to install it yourself. Clone or otherwise
49
- download the repository somewhere to your home directory with
47
+ MesaScript is now available as a gem! Assuming you have the `gem` command up
48
+ and running (you probably do, but if not, check out
49
+ [RubyGems](https://rubygems.org) to get it up and running). Simply run
50
+
51
+ gem install mesa_script
52
+
53
+ and you should be good to go. You'll be able to include MesaScript in your
54
+ ruby files with `require mesa_script`, and `inlist2mesascript` will be
55
+ available to you from the command line to convert your existing inlists to
56
+ mesascript files.
57
+
58
+ If you want to edit the source or don't want to use rubygems, clone or otherwise download the repository somewhere to your home directory with
50
59
 
51
60
  git clone https://github.com/wmwolf/MesaScript.git ~/MesaScript
52
61
 
data/lib/mesa_script.rb CHANGED
@@ -68,7 +68,9 @@ class Inlist
68
68
  # Three ways to access array categories. All methods will cause the
69
69
  # data category to be staged into your inlist, even if you do not change it
70
70
  # Basically, if it appears in your mesascript, it will definitely appear
71
- # in your inlist. There is no way to unflag an entry.
71
+ # in your inlist. A command can be unflagged by calling
72
+ # `unflag_command('COMMAND_NAME')` where COMMAND_NAME is the case-sensitive
73
+ # name of the command to be unflagged.
72
74
  #
73
75
  # 1. Standard array way like
74
76
  # xa_lower_limit_species[1] = 'h1'
@@ -165,7 +167,7 @@ class Inlist
165
167
  # Two ways to access/change scalars. All methods will cause the data category
166
168
  # to be staged into your inlist, even if you do not change the value.
167
169
  # Basically, if it appears in your mesascript, it will definitely appear in
168
- # your inlist. There is no way to unflag an entry.
170
+ # your inlist.
169
171
  #
170
172
  # 1. Change value, like
171
173
  # initial_mass(1.0)
@@ -181,6 +183,10 @@ class Inlist
181
183
  # syntaxes are allowed, though the one without parentheses is more
182
184
  # traditional for ruby (why do you want empty parentheses anyway?). Returns
183
185
  # current value.
186
+ #
187
+ # A command can be unflagged by calling `unflag_command('COMMAND_NAME')`
188
+ # where COMMAND_NAME is the case-sensitive name of the command to be
189
+ # unflagged.
184
190
 
185
191
  def self.make_regular_method(datum)
186
192
  name = datum.name
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: mesa_script
3
3
  version: !ruby/object:Gem::Version
4
- version: '0.1'
4
+ version: 0.1.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - William Wolf