Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Prepare release 3.1.0 #366

Merged
merged 3 commits into from
Aug 28, 2020
Merged

Prepare release 3.1.0 #366

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a15b5ee
Reflow text in doc/tutorials.rst
khaeru Aug 28, 2020
72397d7
Properly mark deprecation of Scenario.remove_meta()
khaeru Aug 28, 2020
0262d16
Prepare v3.1.0
khaeru Aug 28, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions RELEASE_NOTES.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
Next release
============
v3.1.0 (2020-08-28)
===================

All changes
-----------

ixmp v3.1.0 coincides with message_ix v3.1.0.

- :pull:`345`: Fix a bug in :meth:`.read_excel` when parameter data is spread across multiple sheets.
- :pull:`363`: Expand documentation and revise installation instructions.
- :pull:`362`: Raise Python exceptions from :class:`.JDBCBackend`.
Expand Down
6 changes: 2 additions & 4 deletions doc/source/tutorials.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,8 @@
Adapting GAMS models for :mod:`ixmp`
------------------------------------

The common example optimization from Dantzig :cite:`dantzig-1963`, is available in a GAMS implementation
`from the GAMS website <https://www.gams.com/mccarl/trnsport.gms>`_.
The file ``tutorial/transport/transport_ixmp.gms`` illustrates how an
existing GAMS model can be adapted to work with the |ixmp|.
The common example optimization from Dantzig :cite:`dantzig-1963` is available in a GAMS implementation `from the GAMS website <https://www.gams.com/mccarl/trnsport.gms>`_.
The file :file:`tutorial/transport/transport_ixmp.gms` illustrates how an existing GAMS model can be adapted to work with the |ixmp|.
The same, simple procedure can be applied to any GAMS code.

The steps are:
Expand Down
9 changes: 6 additions & 3 deletions ixmp/core.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1663,15 +1663,18 @@ def set_meta(self, name_or_dict, value=None):
self.scenario, self.version)

def delete_meta(self, *args, **kwargs):
"""DEPRECATED: Remove scenario meta.
"""Remove scenario meta.

.. deprecated:: 3.1

Use :meth:`remove_meta()`.

Parameters
----------
name : str or list of str
Either single meta key or list of keys.
"""
warn('Scenario.delete_meta is deprecated; use Scenario.remove_meta '
'instead', DeprecationWarning)
warn("Scenario.delete_meta(); use remove_meta()", DeprecationWarning)
self.remove_meta(*args, **kwargs)

def remove_meta(self, name):
Expand Down
2 changes: 1 addition & 1 deletion rixmp/DESCRIPTION
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Package: rixmp
Type: Package
Title: R Interface to the IX Modeling Platform
Version: 3.0.0.9000
Version: 3.1.0
Authors@R: c(
person("Adriano", "Vinca", email = "vinca@iiasa.ac.at",
role = c("aut", "cre")),
Expand Down
8 changes: 4 additions & 4 deletions tutorial/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ This problem finds a least cost shipping schedule that meets demand requirements
The tutorials are provided as Jupyter notebooks for both Python and R, and are identical as far as possible.

- Tutorial 1:
in `Python <https://github.com/iiasa/ixmp/blob/master/tutorial/transport/py_transport.ipynb>`__,
or in `R <https://github.com/iiasa/ixmp/blob/master/tutorial/transport/R_transport.ipynb>`__.
in `Python <https://github.com/iiasa/ixmp/blob/v3.1.0/tutorial/transport/py_transport.ipynb>`__,
or in `R <https://github.com/iiasa/ixmp/blob/v3.1.0/tutorial/transport/R_transport.ipynb>`__.

This tutorial walks through the following steps:

Expand All @@ -25,7 +25,7 @@ The tutorials are provided as Jupyter notebooks for both Python and R, and are i
5. Display the solution (variables and equation).

- Tutorial 2:
in `Python <https://github.com/iiasa/ixmp/blob/master/tutorial/transport/py_transport_scenario.ipynb>`__,
or in `R <https://github.com/iiasa/ixmp/blob/master/tutorial/transport/R_transport_scenario.ipynb>`__.
in `Python <https://github.com/iiasa/ixmp/blob/v3.1.0/tutorial/transport/py_transport_scenario.ipynb>`__,
or in `R <https://github.com/iiasa/ixmp/blob/v3.1.0/tutorial/transport/R_transport_scenario.ipynb>`__.

This tutorial creates an alternate or ‘counterfactual’ scenario of the transport problem; solves it; and compares the results to the original or reference scenario.