mesa_cli 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2908874ec54278806e2984d1e0f60076bbb94e6d
-  data.tar.gz: 7fdc828dbc702fc9bd3ce850db318f1f4300a49f
+  metadata.gz: 3a497f66bb80bf3e052db6cb16a5ffb001a526f1
+  data.tar.gz: 9a048c142c45c45fb7d32c742cecb5d504a2ac1a
 SHA512:
-  metadata.gz: 09c4ef4e454b92891033436bb9e8625c3a2f4ac52fd8cd52573c9dc0b72625bedc6abd60920d518d2759655e703e31c1d3458e8c3a55218e4352152bf6846096
-  data.tar.gz: 1cee8d38e282cc546c626fae00500dc66fd6fad9762f47f0b68f810715dfc4548d865d48a97f1b4dd33b23ae95e343c45d20beebfc6cfb418ee7e11f4c95292d
+  metadata.gz: 74ecd902c0c213c4c13a7853e1aa96286489d8695211b807673e4315e602d8f860576d60cbef2c0eb776bc30d32945d98941e18d65ce80bd880051918180d12e
+  data.tar.gz: f3755547aea252100207d6ed222bfb0470ff4b278d1556e28541d3ac7568e593836da14c646403bd9d78ed33e724844de652aead7c249562a4634b56ef7f4b06

data/README.md

@@ -40,7 +40,8 @@ as detailed below.
 
 To get quick information, type `mesa help` to list the commands and see what
 they do. For detailed information on a particular command, type `mesa help
-command` to learn about an individual command (replacing the word "command" with the actual subcommand name). Brief summaries of commands are below.
+command` to learn about an individual command (replacing the word "command" 
+with the actual subcommand name). Brief summaries of commands are below.
 
 ### default
 
@@ -59,6 +60,56 @@ instance,
 
 will open `$MESA_DIR/star/defaults/star_job.defaults` in vim or whatever default editor you've set up.
 
+### install
+
+To use, just type
+
+    mesa install VERSION_NUMBER [DIR_NAME] --shell=MYSHELL
+
+This will do a fresh checkout of mesa (version number given by VERSION_NUMBER) 
+into a directory (named DIR_NAME, default is mesa-rXXXX, where XXXX is the 
+version number). After the checkout, mesa will install, and your login scripts 
+will be updated to point MESA_DIR to this new installation directory.
+
+By default, the shell is assumed to be bash, so `~/.bash_profile` and 
+`~/.bashrc` will be checked for instances of `MESA_DIR=` in these files, which
+are then updated to point to the new installation path. If no such assignments 
+are found, one will be added to `~/.bash_profile` (if that file does not 
+exist, it will be added to `~/.bashrc`, if it exists). There is a `--shell=` 
+option, but it is currently useless since there is only one shell option.
+
+Currently there is no support for the C shell, but this will be an feature in a future version. For a basic installation with no mucking around of shell scripts, add the `--basic` or `-b` flag.
+
+Some examples:
+
+    mesa install 9999
+
+will download and install mesa revision 9999 into a directory named
+`mesa-r9999` in the current directory. It will then try to find the files
+`~/.bash_profile` and `~/.bashrc`. If it finds them, it will first try to
+update any lines conatining `MESA_DIR=` to point them to the new,
+fully-qualified path to `mesa-r9999`. If no such lines are added, it will add
+the appropriate line (`export MESA_DIR=/PATH/TO/mesa-r9999`) at the end of one
+of those scripts, preferring `~/.bash_profile`.
+
+    mesa install $HOME/mesa_installations/my_latest_mesa 9999
+
+will download and install mesa revision 9999 into the directory
+`$HOME/mesa_installations/my_latest_mesa`. Then it will set `MESA_DIR` in 
+login scripts as in the previous example.
+
+    mesa install 9999 -b
+
+will download and install mesa revision 9999 into a directory named
+`mesa-r9999` in the current directory. It will not attempt to change login
+scripts.
+
+    mesa install $HOME/mesa_installations/my_latest_mesa 9999 -b
+
+will download and install mesa revision 9999 into the directory
+`$HOME/mesa_installations/my_latest_mesa`. It will not attempt to change login
+scripts.
+
 ### new
 
 To use, just type 
@@ -117,6 +168,13 @@ from this process is `inlist_test_suite` which currently only serves to set
 the `mesa_dir` via a local path, so references to this inlist are always 
 deleted.
 
+### version
+
+To use, just type
+
+    mesa version
+
+This will just print out the version number of mesa that is currently installed in your MESA_DIR.
 
 
 

data/bin/mesa

@@ -8,7 +8,20 @@ rescue LoadError
   $use_mesascript = false
 end
 
+ALL_POSSIBLE_SCRIPTS = {"bash" => [".bash_profile", ".bashrc"]}
+
 class MyCLI < Thor
+  desc "version", "Display the version number of currently installed MESA."
+
+  def version
+    return unless check_for_mesa_dir
+    v_num = IO.read(File.join(ENV['MESA_DIR'], 'data', 'version_number')).to_i
+    puts v_num
+    return v_num
+  end
+
+
+
   option :simple, :type => :boolean, :aliases => :s,
   :desc => "Just copy work directory and rename it. Nothing done with " +
            "MesaScript."
@@ -178,6 +191,84 @@ class MyCLI < Thor
     system("#{editor} #{File.join(defaults_dir, filename)}#{suffix}")
   end
 
+  desc "install VER_NUMBER [DIR_NAME]", "Installs mesa version VER_NUMBER."
+  long_desc <<-LONGDESC
+  Installs a user-specified version of MESA (latest version number is typically
+  found at http://mesa.sourceforge.net/prereqs.html). The login scripts will
+  also be updated to have the MESA_DIR environment variable point to the new
+  installation location. Currently only the Bourne again shell (bash) is
+  supported, though the actual installation (without login script adjustments)
+  can still be accomplished in other shells.
+  LONGDESC
+  method_option :shell, :type => "string", :aliases => "-s", :default => "bash",
+    :required => "true", :desc => "The shell to be used when editing login "+
+    "scripts. Default is 'bash'. Currently no other options."
+  method_option :basic, :type => "boolean", :aliases => "-b", :desc => "Force "+
+    "a basic installation, which skips any manipulation of login scripts."
+
+  def install(ver_number, custom_name=nil)
+
+    # download proper version of MESA via SVN
+    puts "Downloading MESA version #{ver_number}. This will take awhile."
+    puts ''
+    dir_name = custom_name || "mesa-r#{ver_number}"
+    dir_name = File.absolute_path(dir_name)
+    system("svn co -r #{ver_number} " +
+      "svn://svn.code.sf.net/p/mesa/code/trunk #{dir_name}")
+    puts "Downloaded MESA version #{ver_number}."
+    puts ''
+
+    # install MESA
+    unless have_mesasdk?
+      puts "Installation failed: MESA SDK not set up properly."
+      puts ''
+      return
+    end
+    puts "Now installing. This will take awhile."
+    puts ''
+    start_dir = FileUtils::pwd
+    FileUtils::cd dir_name
+    system("./clean")
+    system("./install")
+    FileUtils::cd(start_dir)
+
+    # detect login scripts
+    shell = options[:shell]
+    possible_scripts = ALL_POSSIBLE_SCRIPTS[shell] || []
+
+    # stop if basic installation or if we don't know how to handle the shell
+
+    if options[:basic] or possible_scripts.empty?
+      if possible_scripts.empty? and not options[:basic]
+        puts "Don't know how to adjust login scripts for shell #{shell}. Exiting."
+        puts ''
+      end
+      puts "Installed MESA version #{ver_number} in #{dir_name}. Your login " +
+      "scripts likely still need to be updated. See \"Set your environment " +
+      "variables\" in http://mesa.sourceforge.net/prereqs.html for details." 
+      puts ''   
+      return
+    end
+
+    # detect login scripts    
+    possible_scripts.map! { |script| File.join(ENV['HOME'], script) }
+    login_scripts = []
+    possible_scripts.each do |script|
+      login_scripts << script if File.exist?(script)
+    end
+
+    # update login scripts to set MESA_DIR properly
+    have_fixed = login_scripts.empty?
+    login_scripts.each do |script| 
+      fixed_this_one = adjust_script(script, dir_name, shell)
+      have_fixed = fixed_this_one unless have_fixed
+    end
+
+    # add MESA_DIR assignment if none are present, favoring .bash_profile
+    unless (have_fixed or login_scripts.empty?)
+      script = login_scripts[0]
+    end
+  end
 
   private
   def create_ms_file(inlist_name, ms_name)
@@ -190,7 +281,18 @@ class MyCLI < Thor
   def check_for_mesa_dir
     return true if ENV['MESA_DIR']
 
-    puts "WARNING: No environment variable $MESA_DIR found. Exiting."
+    puts "WARNING: No environment variable MESA_DIR found. Exiting."
+    return false
+  end
+
+  def have_mesasdk?
+    return true if ENV['MESASDK_ROOT']
+
+    puts "No environment variable MESASDK_ROOT found. Be sure to download and "+
+    "install the latest MESA SDK for your system from "+
+    "http://www.astro.wisc.edu/~townsend/static.php?ref=mesasdk, being sure to"+
+    "set the MESASDK_ROOT environment variable and sourcing the SDK " +
+    "initialization script."
     return false
   end
 
@@ -206,6 +308,61 @@ class MyCLI < Thor
           extra_pgstar_inlist1_name pgstar
     end
   end
+
+  def adjust_script(script, dir_name, shell="bash")
+    have_fixed = false
+    case shell
+    when "bash"
+      # read in script to array of strings
+      contents = IO.readlines(script)
+
+      # identify lines with MESA_DIR assignment
+      lines_to_fix = []
+      contents.each_with_index do |line, i|
+        if line =~ /export MESA_DIR=.*/
+          lines_to_fix << i
+        end
+      end
+
+      # adjust MESA_DIR location and document changes
+      lines_to_fix.reverse.each do |i|
+        have_fixed = true
+        line = contents[i]
+        contents[i].sub!(/=.*/, "=#{dir_name}")
+        contents.insert(i-1, '# ' + "Changed MESA_DIR to #{dir_name} on " + 
+          "#{Time.now.ctime} from mesa install script.")
+      end
+
+      # write out adjusted contents to file
+      if have_fixed
+        IO.write(script, contents.join)
+        puts "Adjusted MESA_DIR variable in #{script}."
+      end
+
+    else
+      raise "Cannot adjust #{script} because shell \"#{shell}\" is unsupported."
+    end
+    return have_fixed
+  end
+
+  def add_assignment_to_script(script, dir_name, shell="bash")
+    contents = IO.readlines(script)
+    contents << "\n"
+    contents << '# Added by mesa install tool on ' + Time.now.to_s + ".\n"
+    contents << assignment_line('MESA_DIR', dir_name, shell)
+    IO.write(script, contents.join)
+    puts "Added MESA_DIR environment variable to #{script}."
+  end
+
+  def assignment_line(var_name, value, shell)
+    case shell
+    when bash
+      "export #{var_name}=#{value}\n"
+    else
+      raise "Cannot make assignments for shell #{shell} because #{shell} is " +
+      "not a supported shell."
+    end
+  end
 end
 
 MyCLI.start(ARGV)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mesa_cli
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - William Wolf
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-30 00:00:00.000000000 Z
+date: 2015-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: 0.1.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: 0.1.4
 description: "    MESA CLI is a command-line interface for doing several tasks with
   Modules\n    for Experiments in Stellar Astrophysics (MESA; mesa.sourceforge.net).
   This\n    package includes one executable, `mesa`. Actions are performed by entering\n
@@ -59,7 +59,10 @@ homepage: https://wmwolf.github.io
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message: "  Thanks for installing mesa_cli!\n\n  To learn more about
+  how to use the mesa command line tool and to keep up to\n  date with its features,
+  check out the README at the project homepage:\n\n  https://github.com/wmwolf/mesa_cli\n
+  \ \n"
 rdoc_options: []
 require_paths:
 - lib