cmdstan 0.1.9 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86b23f06c13af5825711739c0fc3a66c141fabc38507fd6b4e3e067137422c38
-  data.tar.gz: 4921aae2623e273021f1a3f37f11bd16631902f0b6fb663b36a28d8412968abf
+  metadata.gz: ca789cf84801bb8236e317d7fa3d0f4946f1dde0af355975adf48fba6d4aae38
+  data.tar.gz: fcf91454404ba92fa54e68102d86826fb51e390f8277d6552b9d8805c8f48ad7
 SHA512:
-  metadata.gz: bfe6e78ce9194750c3ee8c89ac02eb9e1b5526c502f9e0908bd5a3c2f3296bb7650de0e0abc61381142a2888c3bb0dedac2d9c80db252084ccf51a7d7f91e41c
-  data.tar.gz: c6176782e0ffb1c9817ab4db949a0e208a143c87c2420ee1747de3149e3b590d6298b019052d5425dd8ec533f32acd190698dee8bb17fc291e96fd2770f0f1ed
+  metadata.gz: 7e093e742ddd620087178b2db7ae8c854f40392e0f8b89f6db84bc9492d897c800d39ed0951523809808b91df08c0b2342503bcfbf2495a750ceb0651b5ea199
+  data.tar.gz: 45b9a5b9bc4fdad879d0a72ef8c0aa1d3fbe06a9ea3aeadd5ca1f18b7fae6add8190e539d55412bc46861621e9cba1bcc0e7110aa472237e2cb5383ecd781f68

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 0.2.0 (2022-04-23)
+
+- CmdStan now installs when the first model is compiled rather than on gem installation
+- Added `cmdstan_installed?` and `install_cmdstan` methods
+- Updated CmdStan to 2.29.2
+- Fixed issue with `summary` method
+- Dropped support for Ruby < 2.7
+
 ## 0.1.9 (2022-02-07)
 
 - Added support for Linux ARM

data/README.md

@@ -12,8 +12,6 @@ Add this line to your application’s Gemfile:
 gem "cmdstan"
 ```
 
-Installation can take a few minutes as CmdStan downloads and builds.
-
 ## Getting Started
 
 Create a Stan file, like `bernoulli.stan`
@@ -32,7 +30,7 @@ model {
 }
 ```
 
-Compile the model
+Compile the model (this can take a few minutes the first time as CmdStan downloads and builds)
 
 ```ruby
 model = CmdStan::Model.new(stan_file: "bernoulli.stan")
@@ -51,6 +49,12 @@ Summarize the results
 fit.summary
 ```
 
+Load a compiled model
+
+```ruby
+model = CmdStan::Model.new(exe_file: "bernoulli")
+```
+
 ## Maximum Likelihood Estimation
 
 ```ruby
@@ -58,6 +62,20 @@ mle = model.optimize(data: data)
 mle.optimized_params
 ```
 
+## Reference
+
+Check if CmdStan is installed
+
+```ruby
+CmdStan.cmdstan_installed?
+```
+
+Install CmdStan manually
+
+```ruby
+CmdStan.install_cmdstan
+```
+
 ## Credits
 
 This library is modeled after the [CmdStanPy API](https://github.com/stan-dev/cmdstanpy).
@@ -81,6 +99,5 @@ To get started with development:
 git clone https://github.com/ankane/cmdstan-ruby.git
 cd cmdstan-ruby
 bundle install
-bundle exec ruby ext/cmdstan/extconf.rb
 bundle exec rake test
 ```

data/lib/cmdstan/install.rb

@@ -0,0 +1,100 @@
+module CmdStan
+  module Install
+    def cmdstan_version
+      "2.29.2"
+    end
+
+    def cmdstan_installed?
+      Dir.exist?(CmdStan.path)
+    end
+
+    def install_cmdstan
+      version = cmdstan_version
+      dir = CmdStan.path
+
+      # TODO figure out Mac ARM
+      if RbConfig::CONFIG["host_os"] !~ /darwin/i && RbConfig::CONFIG["host_cpu"] =~ /arm|aarch64/i
+        checksum = "9b7eec78e217cab39d3d794e817a1ca08f36b1e5cb434c4cd8263bb2650ba125"
+        url = "https://github.com/stan-dev/cmdstan/releases/download/v#{version}/cmdstan-#{version}-linux-arm64.tar.gz"
+      else
+        checksum = "567b531fa73ffdf706caa17eb3344e1dfb41e86993caf8ba40875ff910335153"
+        url = "https://github.com/stan-dev/cmdstan/releases/download/v#{version}/cmdstan-#{version}.tar.gz"
+      end
+
+      puts "Installing CmdStan version: #{version}"
+      puts "Install directory: #{dir}"
+
+      # only needed if default path
+      FileUtils.mkdir_p(File.expand_path("../../tmp", __dir__)) unless ENV["CMDSTAN"]
+
+      if Dir.exist?(dir)
+        puts "Already installed"
+        return true
+      end
+
+      Dir.mktmpdir do |tmpdir|
+        puts "Downloading..."
+        download_path = File.join(tmpdir, "cmdstan-#{version}.tar.gz")
+        download_file(url, download_path, checksum)
+
+        puts "Unpacking..."
+        path = File.join(tmpdir, "cmdstan-#{version}")
+        FileUtils.mkdir_p(path)
+        tar_args = Gem.win_platform? ? ["--force-local"] : []
+        system "tar", "xzf", download_path, "-C", path, "--strip-components=1", *tar_args
+
+        puts "Building..."
+        make_command = Gem.win_platform? ? "mingw32-make" : "make"
+        Dir.chdir(path) do
+          # disable precompiled header to save space
+          output, status = Open3.capture2e(make_command, "build", "PRECOMPILED_HEADERS=false")
+          if status.exitstatus != 0
+            puts output
+            raise Error, "Build failed"
+          end
+        end
+
+        FileUtils.mv(path, dir)
+      end
+
+      puts "Installed"
+
+      true
+    end
+
+    private
+
+    def download_file(url, download_path, checksum, redirects = 0)
+      raise Error, "Too many redirects" if redirects > 10
+
+      uri = URI(url)
+      location = nil
+
+      Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
+        request = Net::HTTP::Get.new(uri)
+        http.request(request) do |response|
+          case response
+          when Net::HTTPRedirection
+            location = response["location"]
+          when Net::HTTPSuccess
+            digest = Digest::SHA2.new
+
+            File.open(download_path, "wb") do |f|
+              response.read_body do |chunk|
+                f.write(chunk)
+                digest.update(chunk)
+              end
+            end
+
+            raise Error, "Bad checksum: #{digest.hexdigest}" if digest.hexdigest != checksum
+          else
+            raise Error, "Bad response"
+          end
+        end
+      end
+
+      # outside of Net::HTTP block to close previous connection
+      download_file(location, download_path, checksum, redirects + 1) if location
+    end
+  end
+end

data/lib/cmdstan/mcmc.rb

@@ -30,7 +30,7 @@ module CmdStan
       run_command "#{CmdStan.path}/bin/stansummary#{extension}", "--csv_filename=#{path}", *@output_files.map(&:path)
 
       result = {}
-      CSV.foreach(path, headers: true, converters: :numeric) do |row|
+      CSV.foreach(path, skip_lines: /^#/, headers: true, converters: :numeric) do |row|
         value = row.to_h
         name = value.delete("name")
         result[name] = value if name == "lp__" || !name.end_with?("__")

data/lib/cmdstan/model.rb

@@ -18,8 +18,12 @@ module CmdStan
     end
 
     def compile
+      unless ENV["CMDSTAN"] || CmdStan.cmdstan_installed?
+        CmdStan.install_cmdstan
+      end
+
       Dir.chdir(CmdStan.path) do
-        run_command make_command, @exe_file
+        run_command make_command, @exe_file, "PRECOMPILED_HEADERS=false"
       end
     end
 

data/lib/cmdstan/version.rb

@@ -1,3 +1,3 @@
 module CmdStan
-  VERSION = "0.1.9"
+  VERSION = "0.2.0"
 end

data/lib/cmdstan.rb

@@ -1,10 +1,14 @@
 # stdlib
+require "digest"
 require "csv"
+require "fileutils"
 require "json"
+require "net/http"
 require "open3"
 require "tempfile"
 
 # modules
+require "cmdstan/install"
 require "cmdstan/utils"
 require "cmdstan/mcmc"
 require "cmdstan/mle"
@@ -14,6 +18,8 @@ require "cmdstan/version"
 module CmdStan
   class Error < StandardError; end
 
+  extend Install
+
   class << self
     attr_accessor :path
   end

metadata

@@ -1,28 +1,26 @@
 --- !ruby/object:Gem::Specification
 name: cmdstan
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.2.0
 platform: ruby
 authors:
 - Andrew Kane
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-07 00:00:00.000000000 Z
+date: 2022-04-23 00:00:00.000000000 Z
 dependencies: []
 description:
 email: andrew@ankane.org
 executables: []
-extensions:
-- ext/cmdstan/extconf.rb
+extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
-- ext/cmdstan/Makefile
-- ext/cmdstan/extconf.rb
 - lib/cmdstan.rb
+- lib/cmdstan/install.rb
 - lib/cmdstan/mcmc.rb
 - lib/cmdstan/mle.rb
 - lib/cmdstan/model.rb
@@ -40,14 +38,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Bayesian inference for Ruby, powered by CmdStan

data/ext/cmdstan/Makefile

@@ -1,5 +0,0 @@
-install:
-	@echo "Nothing to do"
-
-clean:
-	@echo "Nothing to do"

data/ext/cmdstan/extconf.rb

@@ -1,75 +0,0 @@
-require "digest"
-require "fileutils"
-require "net/http"
-require "tmpdir"
-
-version = "2.28.2"
-# TODO figure out Mac ARM
-if RbConfig::CONFIG["host_os"] !~ /darwin/i && RbConfig::CONFIG["host_cpu"] =~ /arm|aarch64/i
-  checksum = "cd8f588a1267e3e36761b7bcdff1b7f36bf43b8ec119667654995bfa5f921fa4"
-  url =  "https://github.com/stan-dev/cmdstan/releases/download/v#{version}/cmdstan-#{version}-linux-arm64.tar.gz"
-else
-  checksum = "4e6ed2685460d7f33ddbc81ccb1e59befa7efd91e46d5b040027aab8daec4526"
-  url = "https://github.com/stan-dev/cmdstan/releases/download/v#{version}/cmdstan-#{version}.tar.gz"
-end
-
-path = ENV["CMDSTAN"] || File.expand_path("../../tmp/cmdstan", __dir__)
-FileUtils.mkdir_p(path)
-raise "Directory not empty. Run: rake clean" unless Dir.empty?(path)
-
-$stdout.sync = true
-
-def download_file(url, download_path, checksum, redirects = 0)
-  raise "Too many redirects" if redirects > 10
-
-  uri = URI(url)
-  location = nil
-
-  Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
-    request = Net::HTTP::Get.new(uri)
-    http.request(request) do |response|
-      case response
-      when Net::HTTPRedirection
-        location = response["location"]
-      when Net::HTTPSuccess
-        digest = Digest::SHA2.new
-
-        i = 0
-        File.open(download_path, "wb") do |f|
-          response.read_body do |chunk|
-            f.write(chunk)
-            digest.update(chunk)
-
-            # print progress
-            putc "." if i % 50 == 0
-            i += 1
-          end
-        end
-        puts # newline
-
-        abort "Bad checksum: #{digest.hexdigest}" if digest.hexdigest != checksum
-      else
-        abort "Bad response"
-      end
-    end
-  end
-
-  # outside of Net::HTTP block to close previous connection
-  download_file(location, download_path, checksum, redirects + 1) if location
-end
-
-# download
-puts "Downloading #{url}..."
-download_path = "#{Dir.tmpdir}/cmdstan-#{version}.tar.gz"
-download_file(url, download_path, checksum)
-
-# extract
-Dir.chdir(path)
-# TODO use Gem::Package::TarReader from Rubygems
-tar_args = Gem.win_platform? ? ["--force-local"] : []
-system "tar", "zxf", download_path, "-C", path, "--strip-components=1", *tar_args
-
-# build
-make_command = Gem.win_platform? ? "mingw32-make" : "make"
-success = system(make_command, "build")
-raise "Build failed" unless success