cmdstan 0.1.7 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b8f1ac614181c49f61854a38bf6c8e7ec1ed7e67fe985a98555e5a8d715f721
-  data.tar.gz: 7c468282651c7c4641de099d1d113136b91b4962a01e088990eb48962bb32be8
+  metadata.gz: ca789cf84801bb8236e317d7fa3d0f4946f1dde0af355975adf48fba6d4aae38
+  data.tar.gz: fcf91454404ba92fa54e68102d86826fb51e390f8277d6552b9d8805c8f48ad7
 SHA512:
-  metadata.gz: 1acc7f793f86024eb4dc289f7cbb6029aab0991fac2c8423f06b0339b2e4570a90b8a173bf9d659eb1e0d70635d367f5b2d96e753be0a1a91c5d8d2f6f786ec2
-  data.tar.gz: 9b8ce497e5bec32cec243003f87a5dccbdaeb8139c1b204c7e0f75d610b651bae5bd1191f3b29c627b2fa47db0ef96b549d7537d66a901d89bfe60207b05dd2d
+  metadata.gz: 7e093e742ddd620087178b2db7ae8c854f40392e0f8b89f6db84bc9492d897c800d39ed0951523809808b91df08c0b2342503bcfbf2495a750ceb0651b5ea199
+  data.tar.gz: 45b9a5b9bc4fdad879d0a72ef8c0aa1d3fbe06a9ea3aeadd5ca1f18b7fae6add8190e539d55412bc46861621e9cba1bcc0e7110aa472237e2cb5383ecd781f68

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+## 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
+- Updated CmdStan to 2.28.2
+
+## 0.1.8 (2022-01-16)
+
+- Updated CmdStan to 2.28.1
+
 ## 0.1.7 (2021-08-23)
 
 - Updated CmdStan to 2.27.0

data/LICENSE.txt

@@ -1,7 +1,7 @@
 BSD 3-Clause License
 
 Copyright (c) 2019, Stan Developers and their Assignees
-Copyright (c) 2020-2021, Andrew Kane
+Copyright (c) 2020-2022, Andrew Kane
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

data/README.md

@@ -2,18 +2,16 @@
 
 Bayesian inference for Ruby, powered by [CmdStan](https://github.com/stan-dev/cmdstan)
 
-[![Build Status](https://github.com/ankane/cmdstan/workflows/build/badge.svg?branch=master)](https://github.com/ankane/cmdstan/actions)
+[![Build Status](https://github.com/ankane/cmdstan-ruby/workflows/build/badge.svg?branch=master)](https://github.com/ankane/cmdstan-ruby/actions)
 
 ## Installation
 
 Add this line to your application’s Gemfile:
 
 ```ruby
-gem 'cmdstan'
+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,29 +62,42 @@ 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).
 
 ## History
 
-View the [changelog](https://github.com/ankane/cmdstan/blob/master/CHANGELOG.md)
+View the [changelog](https://github.com/ankane/cmdstan-ruby/blob/master/CHANGELOG.md)
 
 ## Contributing
 
 Everyone is encouraged to help improve this project. Here are a few ways you can help:
 
-- [Report bugs](https://github.com/ankane/cmdstan/issues)
-- Fix bugs and [submit pull requests](https://github.com/ankane/cmdstan/pulls)
+- [Report bugs](https://github.com/ankane/cmdstan-ruby/issues)
+- Fix bugs and [submit pull requests](https://github.com/ankane/cmdstan-ruby/pulls)
 - Write, clarify, or fix documentation
 - Suggest or add new features
 
 To get started with development:
 
 ```sh
-git clone https://github.com/ankane/cmdstan.git
-cd cmdstan
+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.7"
+  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,34 +1,32 @@
 --- !ruby/object:Gem::Specification
 name: cmdstan
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.2.0
 platform: ruby
 authors:
 - Andrew Kane
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-23 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
 - lib/cmdstan/utils.rb
 - lib/cmdstan/version.rb
-homepage: https://github.com/ankane/cmdstan
+homepage: https://github.com/ankane/cmdstan-ruby
 licenses:
 - BSD-3-Clause
 metadata: {}
@@ -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.2.22
+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,66 +0,0 @@
-require "digest"
-require "fileutils"
-require "net/http"
-require "tmpdir"
-
-version = "2.27.0"
-checksum = "ff71f4d255cf26c2d8366a8173402656a659399468871305056aa3d56329c1d5"
-url = "https://github.com/stan-dev/cmdstan/releases/download/v#{version}/cmdstan-#{version}.tar.gz"
-
-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)
-  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" 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) 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"
-system make_command, "build"