iOS SDK - Installation

CocoaPods

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 file with Xcode. Do NOT use *.xcodeproj as you’ll receive ld: library not found errors for the AerisWeather libraries.

6. 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

7. Follow our setup guide to start using the SDK.

Carthage

Carthage

1. Install the latest version of Carthage .

2. Add the following to your Cartfile:

   binary "/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 except for AerisGoogleMapKit.framework.

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. If you are using Google Maps, you’ll also need to add AerisGoogleMapKit.framework to your project’s Link Binary with Library build phase since it’s a static framework and cannot be loaded dynamically. You can skip this step if you aren’t using the SDK with Google Maps.

10. Follow our setup guide to start using the SDK.

XCFrameworks

XCFrameworks

As of version 3.3.0 of the Xweather iOS SDK, libraries are built to support multiple platforms in Apple’s supported XCFramework format.

1. Download  the latest version of the Xweather iOS SDK and decompress the downloaded archive file.

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*###*.xcframework files you need located within the decompressed directory you downloaded and select them except for AerisGoogleMapKit.xcframework. Make sure to check the Destination: Copy items if needed checkbox when prompted.

4. If you are using Google Maps, you’ll also need to add AerisGoogleMapKit.xcframework to your project’s Link Binary with Library build phase since it’s a static framework and cannot be loaded dynamically. You can skip this step if you aren’t using the SDK with Google Maps.

5. Follow our setup guide to start using the SDK.

Dynamic Frameworks

Dynamic Frameworks

1. Download  the latest version of the Xweather iOS SDK and decompress the downloaded archive file.

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 you need located within the decompressed directory you downloaded and select them except for AerisGoogleMapKit.framework. 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. If you are using Google Maps, you’ll also need to add AerisGoogleMapKit.framework to your project’s Link Binary with Library build phase since it’s a static framework and cannot be loaded dynamically. You can skip this step if you aren’t using the SDK with Google Maps.

6. Follow our setup guide to start using the SDK.

CocoaPods

CocoaPods

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

Carthage

Carthage

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

Dynamic Frameworks

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.