Installation

To get started with the Aeris Weather SDK for iOS, you'll need to integrate the SDK into an existing project.

The Aeris Weather SDK for iOS has the following requirements:

  • Xcode 8 or later
  • iOS 9 or later

You can review the demo application that already has the SDK integrated with sample code and views.

Including the SDK in a Project

There are several ways you can integrate the iOS SDK with your own existing project:

Select one of the above methods to integrate the SDK based on your preferred method, but don't use more than one method as that will result in duplicate copies of the SDK and compiler errors.

CocoaPods

  1. Make sure you have CocoaPods installed and working. If you don't have CocoaPods installed on your system, follow the installation instructions to get started. If you're new to or unfamiliar with CocoaPods, also make sure to review its usage guide to learn more about how to get started with CocoaPods for your project.
  2. Add the AerisWeather pod to your Podfile. This will add the base AerisWeatherKit.framework and its core dependencies to your project.

    pod 'AerisWeather'
  3. If you want to also use any of the weather mapping functionality available in our iOS SDK, you'll need to also include the Maps pod:

    pod 'AerisWeather/Maps'
    
    # include this if using Mapbox for maps in your project
    pod 'AerisWeather/Mapbox'
    
    # or include this if using Google Maps for maps in your project
    pod 'AerisWeather/GoogleMaps'
  4. Run pod install from the Terminal at the root of your project where your Podfile is located.

  5. Open your *.xcworkspace with Xcode and follow our setup guide to start using the SDK. Note: Do NOT use *.xcodeproj as you'll receive ld: library not found errors for the Aeris Weather SDK libraries.

Carthage

  1. Install the latest version of Carthage.
  2. Add the following to your Cartfile:

    binary "https://www.aerisweather.com/downloads/ios/AerisWeather.json"
  3. Run carthage update.

  4. In your app target's General settings tab, under the Linked Frameworks and Libraries section, drag and drop all the Aeris###.framework files (e.g. AerisCore.framework, AerisWeatherKit.framework, etc) you wish to use from the Carthage/Build/iOS folder on disk.

  5. In the Build Phases tab, click the + icon and choose New Run Script Phase. Create a Run Script phase and add the following to the script area below the shell:

    /usr/local/bin/carthage copy-frameworks
  6. Then add the framework paths to the Input Files for this script phase:

    $(SRCROOT)/Carthage/Build/iOS/AerisCore.framework
    $(SRCROOT)/Carthage/Build/iOS/AerisCoreUI.framework
    $(SRCROOT)/Carthage/Build/iOS/AerisWeatherKit.framework
    ...
  7. Review the Carthage setup documentation for more information about setting up your project.

  8. Under the *Build Phases tab of your Target, click the + button on the top-left and select New Run Script Phase. Setup the build phase as follows, and make sure this phase is below the Embed Frameworks phase:

    Shell /bin/sh
    
    bash "${BUILT_PRODUCTS_DIR}/${FRAMEWORKS_FOLDER_PATH}/AerisCore.framework/strip-frameworks.sh"
    
    Show environment variables in build log: Checked
    Run script only when installing: Not checked
    
    Input Files: Empty
    Output Files: Empty
  9. Follow our setup guide to start using the SDK.

Dynamic Frameworks

  1. Download the SDK which is a compressed file archive.
  2. With your project open in Xcode, select your Target. Under the General tab, find Embedded Binaries and then click the + button.
  3. Click the Add Other... button, navigate to the Aeris###.framework` files under Carthage > Build > iOS and select them. Make sure to check the Destination: Copy items if needed checkbox when prompted.
  4. Under the *Build Phases tab of your Target, click the + button on the top-left and select New Run Script Phase. Setup the build phase as follows, and make sure this phase is below the Embed Frameworks phase:

    Shell /bin/sh
    
    bash "${BUILT_PRODUCTS_DIR}/${FRAMEWORKS_FOLDER_PATH}/AerisCore.framework/strip-frameworks.sh"
    
    Show environment variables in build log: Checked
    Run script only when installing: Not checked
    
    Input Files: Empty
    Output Files: Empty
  5. Follow our setup guide to start using the SDK.

Upgrading to a Newer SDK Version

When a new version of the SDK for iOS is released, you can update your project's version using one of the respective methods below.

CocoaPods

  1. Run pod update in the root of your project directory where your Podfile is located.

Carthage

  1. Run carthage update in the root of your project directory.

Dynamic Frameworks

  1. In Xcode, select all Aeris-related frameworks (e.g. AerisCore.framework, AerisWeatherKit.framework, etc) in the Project Navigator and hit delete on your keyboard. Then select Move to Trash.
  2. Follow the dynamic framework installation process above to include the newer version of the SDK.