mesa_script 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6da8112adad23e4734374e1a3464310191e1372da9825668217c6fb3a7f7e19
-  data.tar.gz: 94e45e7647b44d50ad53bfc93fdd68417a06880225fc1206f713cd6d34deda84
+  metadata.gz: 7396508a25fdc1adcf8e7844ce0fe074e2ba9fa8a44e4eb72d15d1a44ef5c185
+  data.tar.gz: 9b71c2c407c51744b0061b89f2a1072f9274caab29ca3f998b01e6d5723533a2
 SHA512:
-  metadata.gz: 904b87d477f8d7625357bd4c1df0eb943180d693668904cd50246826db17185e24b1a6a83a2e8cf77f1cdabbdbba7e892ed1eb8b5d4ca12e853f7da076630810
-  data.tar.gz: 74bd40a0f387b9105be03d3195d73d5899465e875bb25d81f23f09560652a0f61aa7b22b725125278776d8703aa8d5edd04a1e272fc23ac87f22574696aba35b
+  metadata.gz: 3540df671b3609627cff42f20ca156e2238f15c548f660ad365ecc7c539f3c3e1c09fc076d1b385434b9d04218968aead29bde765477f86cbcacf48a9913ff55
+  data.tar.gz: 5fa0b3ffde490b83340a25a5f6dbb983b2e9aab6b7234e9bb2c3fb9c2e82a8489407de133e38a8fbcc47ac5560300fd933d06529e128ed1628e1c453dc13a87a

data/README.md

@@ -1,18 +1,21 @@
 MesaScript
 ==========
 
-###MESA Requirement!
+### MESA Requirement!
 In its current state, MesaScript requires MESA rev. 5596 or above. This is due
 to a sensitivity to where the `'.inc'` files are stored on earlier versions. If
 there is demand for MesaScript for earlier revisions, I will look into making
-it backward compatible.
+it backward compatible. It has been updated to work in the `git` era (beyond
+version 15140), including conditionally adding the `&kap` and `&eos` namelists
+if they are present. It does not currently support `astero` inlists out of the
+box.
 
-###The Short Short Version
+### The Short Short Version
 To get up and running fast, skip to installation, then try and use the included
 sample file, `sample.rb` (via running `ruby sample.rb` in the command line). The
 comments in `sample.rb` should get you started, especially if you have at least
 a little Ruby know-how.
-###What is MesaScript?
+### What is MesaScript?
 Lightweight, Ruby-based language that provides a powerful way to make inlists
 for MESA projects. Really, MesaScript is a DSL (domain-specific language) built
 on top of Ruby, so Ruby code "just works" inside MesaScript (if you're familiar
@@ -43,7 +46,7 @@ are pretty wide open. You could easily make a script that starts with a given
 set of parameters, run MESA star, then use the output of that run to dictate a
 new inlist and run, creating a chain (maybe a MESA root find of sorts).
 
-###Installation
+### Installation
 MesaScript is now available as a gem! Assuming you have the `gem` command up
 and running (you probably do, but if not, check out 
 [RubyGems](https://rubygems.org) to get it up and running). Simply run
@@ -91,7 +94,7 @@ work. The `mesa_script.rb` file generates all the necessary data it needs from
 the MESA source on the fly (this also makes it nearly MESA version
 independent).
 
-###Basic Usage
+### Basic Usage
 The `mesa_script.rb` file defines just one class, Inlist, which we'll interact
 with primarily through one class method, `make_inlist`. Just put the following
 in a file to make a blank inlist:
@@ -113,14 +116,14 @@ by the way). Then to actually generate the inlist, enter
 MesaScript, and you did so using fewer lines than it would have taken to
 actually make that inlist on your own (technically)!
 
-###Entering Inlist Commands
+### Entering Inlist Commands
 Making blank inlists is boring, so now let's cover how you actually make useful
 inlists. For mesa inlists, there are really only two types of declarations:
 those for scalars and those for array. Let's talk about scalars first, since
 they are far more common. Then we'll get to the more complicated array
 assignments.
 
-####Scalar Assignments
+#### Scalar Assignments
 As an example, let's say we want to set the initial mass of our star to 2.0
 solar masses. The inlist command for this is `initial_mass`. In a regular
 inlist file, we would need to put this in the proper namelist, `&controls` as
@@ -143,7 +146,7 @@ called `initial_mass`. (For the person curious as to why I didn't program this
 functionality in, google something like "instance_eval setter method" to
 discover what took me too long to figure out.)
 
-####Array Assignments
+#### Array Assignments
 As an example, let's say we want to set a lower limit on a certain central
 abundance as a stopping condition. Then we would, at the minimum, need to set
 the inlist command `xa_central_lower_limit_species(1) = 'h1'`, for example. In MesaScript, there are three ways to do this:
@@ -160,7 +163,7 @@ work:
 I tried to program this functionality in, and the kind people at
 [StackOverflow](http://stackoverflow.com/questions/21036873/how-do-i-write-a-method-to-edit-an-array-hash-using-parentheses-instead-of-squar/21044781?noredirect=1#21044781) kindly but firmly convinced me it was utterly impossible to to with Ruby without writing a parser of my own. Just stick to the bracket syntax or the less natural parentheses/space notations.
 
-####Other Details
+#### Other Details
 That's really all you need to know to start making inlists with MesaScript,
 though I should remind you, especially if you aren't familiar with Ruby, about
 the basic types of entries you might use. Most inlist commands are one of the
@@ -218,10 +221,10 @@ inlist commands so you don't forget to change a particular command when you
 move on to a different run (like forgetting to change a `LOG_dir`, which I've
 done a few too many times and thus overwritten some data).
 
-###Deeper and Deeper...
+### Deeper and Deeper...
 Are you still reading this? Well, you must want to do more.
 
-###Using Custom Namelists
+### Using Custom Namelists
 You can also make MesaScript know about additional namelists (or forget about
 the standard three). After requiring the `mesa_script` file, you can change the
 namelists it cares about via the following commands (obviously subbing out any
@@ -252,7 +255,7 @@ That *should* set things up to work with custom namelists, so long as the
 `.inc` and `.defaults` files are formatted more or less the same as the "stock"
 ones.
 
-###Accessing Current Values and Displaying Default Values
+### Accessing Current Values and Displaying Default Values
 Perhaps you want to display a default value in your inlist, but not actually
 change it. Well, most of the assignment methods mentioned earlier
 are also getter methods. I haven't mentioned how these methods actually work, so I'll do so now since you're still reading this manifesto.
@@ -297,5 +300,5 @@ Note that these array methods, as indicated, point to hashes (not arrays) of
 values. So `xa_central_lower_limit_species[1] = 'h1'` would return
 `{1 => 'h1'}`.
 
-##Further Work
+## Further Work
 I warmly welcome bug reports, feature suggestions, and most all, pull requests!

data/lib/mesa_script.rb

@@ -5,14 +5,20 @@ def namelist_sym(namelist)
 end
 
 class Inlist
+
+  # check if this version came from a github repository (newer than 15140)
+  def self.version_is_git?
+    File.exist?(File.join(ENV['MESA_DIR'], '.gitignore')) or File.exist?(File.join(ENV['MESA_DIR'], '.github'))
+  end
+
   # Get access to current MESA version.
   def self.version
-    IO.read(File.join(ENV['MESA_DIR'], 'data', 'version_number')).to_i
+    IO.read(File.join(ENV['MESA_DIR'], 'data', 'version_number')).sub('.', '').sub('r', '')
   end
 
   # Determine proper file suffix for fortran source
   def self.f_end
-    if Inlist.version >= 7380
+    if Inlist.version_is_git? || Inlist.version.to_i >= 7380
       'f90'
     else
       'f'
@@ -21,7 +27,7 @@ class Inlist
 
   # Determine proper file location for star-related .inc files
   def self.star_or_star_data
-    if Inlist.version >= 12245
+    if Inlist.version_is_git? || Inlist.version.to_i >= 12245
       'star_data'
     else
       'star'
@@ -160,6 +166,30 @@ class Inlist
     )
   end
 
+  # short hand for adding kap namelist using sensible defaults as of 22.11.1
+  def self.add_kap_defaults(verbose: false)
+    config_namelist(
+      namelist: :kap,
+      source_files: [File.join(ENV['MESA_DIR'], 'kap', 'private',
+                               "kap_ctrls_io.#{f_end}")],
+      defaults_file: File.join(ENV['MESA_DIR'], 'kap', 'defaults',
+                               'kap.defaults'),
+      verbose: verbose
+    )
+  end
+
+  # short hand for adding eos namelist using sensible defaults as of 22.11.1
+  def self.add_eos_defaults(verbose: false)
+    config_namelist(
+      namelist: :eos,
+      source_files: [File.join(ENV['MESA_DIR'], 'eos', 'private',
+                               "eos_ctrls_io.#{f_end}")],
+      defaults_file: File.join(ENV['MESA_DIR'], 'eos', 'defaults',
+                               'eos.defaults'),
+      verbose: verbose
+    )
+  end
+
   # short hand for adding pgstar namelist using sensible defaults as of 10108
   def self.add_pgstar_defaults(verbose: false)
     config_namelist(
@@ -198,10 +228,14 @@ class Inlist
     )
   end
 
-  # quickly add all three major namelists for star module (star_job, controls,
-  # and pgstar)
+  # quickly add all five (three for older versions) major namelists for star
+  # module (star_job, controls, and pgstar)
   def self.add_star_defaults
     add_star_job_defaults
+    if Inlist.version_is_git? || Inlist.version.to_i > 15140
+      add_kap_defaults
+      add_eos_defaults
+    end
     add_controls_defaults
     add_pgstar_defaults
   end
@@ -656,6 +690,7 @@ class Inlist
         line.split('::').map(&:strip)
       end
       pairs.each do |pair|
+        next if pair[0] == 'public'
         type = case pair[0]
                when /logical/ then :bool
                when /character/ then :string
@@ -663,7 +698,7 @@ class Inlist
                when /integer/ then :int
                when /type/ then :type
                else
-                 raise "Couldn't determine type of entry #{pair[0]} in " \
+                 raise "Couldn't determine type of entry \"#{pair[0]}\" in " \
                        "#{source_file}."
                end
         name_chars = pair[1].split('')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mesa_script
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - William Wolf
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-03-07 00:00:00.000000000 Z
+date: 2023-04-18 00:00:00.000000000 Z
 dependencies: []
 description: MesaScript - a DSL for making dynamic inlists for the MESA stellar evolution
   code.
@@ -25,7 +25,7 @@ homepage: https://billwolf.space/MesaScript/
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -40,14 +40,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.4.12
+signing_key:
 specification_version: 4
 summary: MesaScript is a domain specific language (DSL) that allows the user to write
   inlists for MESA that include variables, loops, conditionals, etc. For more detailed
   instructions, see the readme on the github page at  https://github.com/wmwolf/MesaScript  This
   software requires a relatively modern installation of MESA (version > 5596). It
-  has been tested on Ruby versions > 1.9, but there is no guarantee it will work on
-  older (or newer!) versions. Any bugs or requests should be sent to the author, Bill
-  Wolf, at wmwolf@physics.ucsb.edu.
+  has been tested on Ruby versions > 1.9 and up to 3.2, but there is no guarantee
+  it will work on older (or newer!) versions. Any bugs or requests should be reported
+  to the github repository.
 test_files: []